seanohue / axolemma Goto Github PK

The rooms property returned by Axo.generate is really more of an area property. Change the API eventually but for now just fix the documentation.

Use case: Running a single Ranvier server, wanting to create multiple Axolemma "states" and generate new areas accordingly.

Example:

const MazeGenerator = new Axolemma(mazeOptions);
const CavernGenerator = new Axolemmea(cavernOptions);

Make it newable and have it use the instance options as defaults, taking priority over config files but not over the options passed to generate.

Would need to match the ROT API or something very similar.

To show up as a CLI option it would need to include inquirer-friendly questions configuration.

And would need to be put in a specific directory relative to cwd or require path (.axolemmaplugins?)

Add doors (including locks) psuedo-randomly or using a pattern. Results would be part of the return value of input (e.g., the resulting JSON or YAML would include a door config on each room if applicable).

Document the fact that there are options specific to each type of mapper. Right now roomDugPercentage is thrown in there although it is only relevant to 2 types. Instead, maybe link to the ROT-js docs and list the properties by mapper type.

Make CLI take path to .axolemmaconfig as an argument, and call generate directly.