This project is a Megadungeon Faction Generator for all kinds of TTRPGs. It is the result of a vote by the people of the r/OSR community.
This project is always open for contributions, especially for new content packs; so go ahead and add the things you'd like to see!
You can find this service hosted on TODO.
I also have a discord community, join if you'd like to partake in conversation about this and other projects of mine!
If you want to show some love for what I do, or want help pay the server, you can...
If you want to contribute, or just run the project locally for your own use, follow the instructions below.
This project is built and maintained on Linux. While I don't think it's generally impossible to run on Windows, but the Taskfile is written using Linux commands.
Use the included Taskfile to run these services.
Use this to run the project locally in a docker container.
task local-webserver
If you'd like to run without docker, but with an automatic rebuild when
.templ
templates change, run:
task dev
The project was created with the intention of hosting on Google Cloud Run. Google Cloud Run can be replaced with any serverless platform, but some work will be required if this is your goal, and the following instructions will assume Google Cloud services.
To deploy to Google Cloud, first set all instances of the PROJECT_ID
variable
in the included Taskfile to your project ID.
You may then use task gcloud-setup
to initialize some gcloud
settings.
(Make sure you have gcloud
installed!)
Then, in order to deploy, run task deploy-webserver
. That should be it!
Tests can be run by using the included Taskfile.
task test
- Before posting a pull request, please use
go fmt
to format your code. - Beginners to open source are welcome. If you'd like to contribute, but don't understand something, you're welcome to ask using an issue.
- Please post feature requests as one issue per feature.
- Before working on a larger contribution, please open an issue to ask if the feature you want to implement would be welcome.