/Eigengrau-s-Essential-Establishment-Generator

An establishment generator that is suitable for out of the box play in any fantasy campaign.

Primary LanguageJavaScriptGNU General Public License v3.0GPL-3.0

A Tabletop Generator Unlike Any Other 🎲

Eigengrau's Essential Establishment Generator, or EEEG for short, is a tabletop procedural generation tool for towns, npcs, and more. It creates paragraphs of text suitable to be read directly to the players during a game. No longer do you have to simply describe a generic, unnamed tavern as "small"- this is the sort of stuff that you can read out instead:

What It's For

  • Generate thousands of unique towns for table play
  • Create new plothooks for games
  • Generate new NPCs to flesh out existing places
  • Help new and veteran DMs come up with fresh ideas for their table

Live Build 🚀

Go to https://eigengrausgenerator.com/ to see the most current live build of EEEG in action!

NOTE: The live build is often several weeks or months behind the current build here on GitHub. Compile the generator locally to see all the latest features and updates!

Community 👪

Join our Discord to talk about the project in real time

  • Learn more about the project
  • Ask questions and learn from other contributors
  • Show off your work

DISCORD

Also consider joining the subreddit.

Contributing ✒️

We love getting pull requests! You can find out more about contributing to the project here.

Once you've cloned the project, remember to yarn install or npm install to install the required dependencies.

You will also need to download Tweego from here. and place the contents inside /Eigengrau-s-Essential-Establishment-Generator/.twine if the .twine folder does not already exist just create one.

  • Use npm test to run tests.
  • Use npm build to build the output files. The entire thing will output to the /gh-pages folder as the index.html file.
  • Use npm start to automatically rebuild on file changes.

If you don't want to code, that's okay! The Generator is built out of a novel's worth of words, and we're always in need of more descriptions. You can find writing tasks here.

You can also find easy work to do on the generator here.

Deploying ☁️

To deploy the latest version, build the html file as dist/index.html and run either npm run deploy, or yarn deploy.

Built With 🔨

If you can't contribute pull requests consider supporting the Generator through Patreon

We hope that you find it useful!