The Homebrewery is a tool for making authentic looking D&D content using Markdown. It is distributed under the terms of the MIT License.
The easiest way to get started using the Homebrewery is to use it on our website. The code is open source, so feel free to clone it, tinker with it. If you want to make changes to the code, you can run your own local version for testing by following the installation instructions below.
First, install three programs that the Homebrewery requires to run and retrieve updates
- install node
- install mongodb
- install git (select the option that allows Git to run from the command prompt)
Second, set up the MongoDB database
Third, download a copy of the repository. Once you have git you can do so with
git clone https://github.com/naturalcrit/homebrewery.git
Fourth, you will need to add the environment variable NODE_ENV = local to allow the project to run locally.
You can set this temporarily in your shell of choice:
- Windows Powershell:
$env:NODE_ENV="local" - Windows CMD:
set NODE_ENV=local - Linux / OSX:
export NODE_ENV=local
Fifth, you will need to install the Node dependencies, compile the app, and run it using the two commands:
npm installnpm start
You should now be able to go to http://localhost:8000 in your browser and use the Homebrewery offline.
Please see the docs here: README.DOCKER.md
If you just want the stylesheet that is generated to make pages look like they are from the Player's Handbook, you will find it in the phb.standalone.css file.
If you are developing locally and would like to generate your own, follow the above steps and then run npm run phb.
If you run into any issues using The Homebrewery or have suggestions for improvement, please submit an issue on GitHub. You can also get help for issues on the subreddit r/homebrewery
You can check out the changelog.
This project is licensed under the MIT license. Which means you are free to use The Homebrewery in any way that you want, except for claiming that you made it yourself.
If you wish to sell or in some way gain profit for what's created on this site, it's your responsibility to ensure you have the proper licenses/rights for any images or resources used.