seanohue / ranvier-gen

DEPRECATED - see "axolemma" for an up-to-date Ranvier generation CLI tool
5 stars 0 forks source link

deprecated

I do plan on turning this into a usable CLI tool. Most likely it will be to procedurally generate areas, items, and NPCs for use with RanvierMUD.

WHAT

This is a command-line building tool for Ranvier MUD.

HOW

Well...

Installation

Clone this repo into the plugins directory of your RanvierMUD installation.

Type npm install into your terminal machine to install all dependencies.

This works with any terminals that inquirer.js is compatible with.

Usage

Type node index.js to get started. Answer the questions and it will auto-save YAML files for RanvierMUD rooms to the areas directory.

As of right now, only adding new areas is supported. Adding rooms to previous areas must be done manually.

Dependencies

ranvier-gen uses JS-YAML for parsing and inquirer.js for command-line prompts.

Contribution

This is still in beta form, at best.

I use JS-beautify for code formatting since I'm lazy. The preferences for formatting are saved in the root of this project. This uses mocha.

Run tests using mocha spec in the root directory.