README.md

Eigengrau's Essential Establishment Generator

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!

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 reddit.

Compiling ?

To compile EEEG for local testing you will need the latest version of TweeGo and SugarCube.

# Show TweeGo knows where the SugarCube format is
export TWEEGO_PATH=LOCATION_OF_SUGARCUBE

# go to where you installed Tweego. If you installed it globally, feel free to skip this
cd $TWEEGO_PATH

# replace PROJECT_ROOT with wherever you git cloned the repository
tweego -o EEEG.html {PROJECT_ROOT}/EssentialEstablishmentGenerator --head={PROJECT_ROOT}/main.txt

This generates EEEG.html in the project root directory that you can open in a browser.

NOTE: You can save time once you've set your directories by saving that command as a .bat or .sh file.

Contributing ✒️

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

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.

Built With ?

• Twine - The front end framework
• Sugarcube 2 - A format for Twine
• TweeGo - Twine command line compiler

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

We hope that you find it useful!