This project is still in development and NOT user friendly. A setup process and finishing touches on processing are expected soon.
Once cloned, run npm install to install the necessary modules and then run grunt to "start" development. This will start testing and linting in the background,
start a local web server with the pages assembled, open a web browser to the hosted site, and watch for changes to refresh the page.
Below is a non-comprehensive list of software and other packages notably in use by this application. In the future this will be generated and more comprehensive.
- VueJS V2 for base component handling
- Showdown for Markdown Text processing
- Cytoscape for network visualizations
- ColaJS Plug-in for force directed layout
- HammerJS for touch support
- D3 for graph rending
- XSS for client-side cross-site scripting protection
- JQuery because this is a web application
Below is a list of credits for code snippets that are note-worthy for inspiration or source.
- https://donjon.bin.sh for the base Name Generator code
Below is a list of sites that may be useful when using this tool, or as alternatives to it.
- Azgaar's Fantasy Map Generator for generating random worlds
- Medieval Fantasy City Generator for generating random cities
- Glyphr Studio Online for creating custom font families to include and use witin the webapp