Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ryceg/Eigengrau-s-Essential-Establishment-Generator
A town generator that is suitable for out of the box play in any fantasy TTRPG setting.
https://github.com/ryceg/Eigengrau-s-Essential-Establishment-Generator
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
Last synced: 3 months ago
JSON representation
A town generator that is suitable for out of the box play in any fantasy TTRPG setting.
- Host: GitHub
- URL: https://github.com/ryceg/Eigengrau-s-Essential-Establishment-Generator
- Owner: ryceg
- License: mit
- Created: 2018-04-16T06:10:09.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-02-27T04:04:45.000Z (4 months ago)
- Last Synced: 2024-03-22T12:22:27.209Z (3 months ago)
- Topics: 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
- Language: TypeScript
- Homepage: https://eigengrausgenerator.com
- Size: 196 MB
- Stars: 797
- Watchers: 26
- Forks: 148
- Open Issues: 91
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
- Dei: DeitySchema.json
Lists
- awesome - ryceg/Eigengrau-s-Essential-Establishment-Generator - A town generator that is suitable for out of the box play in any fantasy TTRPG setting. (TypeScript)
- awesome-stars - ryceg/Eigengrau-s-Essential-Establishment-Generator - A town generator that is suitable for out of the box play in any fantasy TTRPG setting. (TypeScript)
- interplanetary-destinesia - Essential Establishment Generator
README
  [](https://github.com/ryceg/Eigengrau-s-Essential-Establishment-Generator/issues) [](https://github.com/ryceg/Eigengrau-s-Essential-Establishment-Generator/network) [](https://github.com/ryceg/Eigengrau-s-Essential-Establishment-Generator/stargazers)
# 
### A Tabletop Generator Unlike Any Other :game_die:
[Eigengrau's Essential Establishment Generator](https://eigengrausgenerator.com/), 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 :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:
[](https://patreon.com/eigengrausgenerator)
**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](https://discord.gg/A543VC5)**
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.](https://www.reddit.com/r/EigengrausGenerator)
## Contributing :black_nib:
 
We love getting pull requests! You can find out more about contributing to the project [here.](https://github.com/ryceg/Eigengrau-s-Essential-Establishment-Generator/wiki/Contributing)
You will need a recent version of [NodeJS](https://nodejs.org),
as well as [Yarn](https://yarnpkg.com/), 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.](https://www.motoslave.net/tweego/) and placing the contents inside _/Eigengrau-s-Essential-Establishment-Generator/.twine_.
if the _.twine_ folder does not already exist, just create one.
* Use `yarn test` to run tests.
* Use `yarn build` to build the output files. (Note that this will return a File Not Found error, but it is working) The entire thing will output to the /gh-pages folder as the index.html file.
* Use `yarn start` to start a development build that automatically rebuilds on file changes (Note that this will complain about circular dependency issues, but will work just fine).
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.](https://github.com/ryceg/Eigengrau-s-Essential-Establishment-Generator/issues?q=is%3Aissue+is%3Aopen+label%3AWriting)
You can also find easy work to do on the generator [here.](https://github.com/ryceg/Eigengrau-s-Essential-Establishment-Generator/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
## Built With :hammer:
* [Twine](https://twinery.org/) - The front end framework
* [Sugarcube 2](https://www.motoslave.net/sugarcube/2/) - A language for Twine
* [TweeGo](https://www.motoslave.net/tweego/) - Twine command line compiler
---
If you can't contribute pull requests consider supporting the Generator through [Patreon](https://www.patreon.com/eigengrausgenerator)
We hope that you find it useful!