Create authentic looking D&D homebrews using only markdown
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 and 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, version v16 or higher.
install mongodb (Community version)
For the easiest installation, follow these steps:
use homebrewery
to create The Homebrewery database. You should see switched to db homebrewery
.db.brews.insertOne({"title":"test"})
to create a blank document. You should see { acknowledged: true, insertedId: ObjectId("63c2fce9e5ac5a94fe2410cf") }
install git (select the option that allows Git to run from the command prompt).
Checkout the repo (documentation):
git clone https://github.com/naturalcrit/homebrewery.git
Second, you will need to add the environment variable NODE_ENV=local
to allow
the project to run locally.
You can set this temporarily (until you close the terminal) in your shell of choice with admin privileges:
$env:NODE_ENV="local"
set NODE_ENV=local
export NODE_ENV=local
If you want to add this variable permanently the steps are as follows:
1. Search in Windows for "Advanced system settings" and open it.
1. Click "Environment variables".
1. In System Variables, click "New"
1. Click "New" and write NODE_ENV
as a name and local
as the value.
1. Click "OK" three times to close all the windows.
This can be undone at any time if needed.
Third, you will need to install the Node dependencies, compile the app, and run it using the two commands:
npm install
npm start
You should now be able to go to http://localhost:8000 in your browser and use The Homebrewery offline.
If you had any issue at all, here are some links that may be useful:
If you still have problems, post in Our Subreddit and we will help you.
Please see the docs here: README.DOCKER.md
Please see the docs here: README.FreeBSD.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.
You are welcome to contribute to the development and maintenance of the project! There are several ways of doing that:
@naturalcrit/issue-managers
.Anyway, if you would like to get in touch with the team and discuss/coordinate your contribution to the project, please join our gitter chat.