Git Product home page Git Product logo

eigengrau-s-essential-establishment-generator's Introduction

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!

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.

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.

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

Use npm test to run tests.

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 ๐Ÿ”จ

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

We hope that you find it useful!

eigengrau-s-essential-establishment-generator's People

Contributors

cktang88 avatar drouu avatar glinkis avatar monsagri avatar ryceg avatar wishingonawendy avatar zer0-ark avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.