ryceg / Eigengrau-s-Essential-Establishment-Generator

A town generator that is suitable for out of the box play in any fantasy TTRPG setting.
https://eigengrausgenerator.com
MIT License
810 stars 148 forks source link
dnd dungeons-and-dragons dungeonsanddragons generator hacktober hacktoberfest hacktoberfest-2022 hacktoberfest-accepted hacktoberfest2022 javascript npc-generator procedural-generation procjam random-generation sugarcube-2 tavern town-generator twine

Website GitHub GitHub issues GitHub forks GitHub stars

A Tabletop Generator Unlike Any Other :game_die:

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

Live Build :rocket:

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!

Docker image

You can build a Docker image to run EEEG in a container, using Node's http-server as a static HTTP server.

  1. Clone the git repository and cd into it.
  2. Run docker build --tag eeeg:latest . to build an image.
  3. Run docker run -p 8080:80 eeeg:latest to start the image. This will bind the container's port 80 to the host's port 8080, so pick something else if you are already using 8080 for something.
  4. Visit http://localhost:8080 to see the live build.

Community :family:

Support me on Patreon

Subreddit subscribers

Discord

Join our Discord to talk about the project in real time

DISCORD

The Discord is where the main realtime discussion happens- GitHub Discussions is for more in-depth discussion about future features.

Also consider joining the subreddit.

Contributing :black_nib:

GitHub issues

GitHub pull requests

GitHub contributors GitHub commit activity

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

You will need a recent version of NodeJS, as well as Yarn, which you can install by running npm install -g yarn once you have NodeJS installed.

Once you've cloned the project, run yarn install to install the required dependencies.

You will also need to download Tweego. You can do so so either by running yarn install-compiler, or by downloading it from here. and placing the contents inside /Eigengrau-s-Essential-Establishment-Generator/.twine. if the .twine folder does not already exist, just create one.

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 :hammer:


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

We hope that you find it useful!