mirror of
https://github.com/naturalcrit/homebrewery.git
synced 2025-12-30 17:32:38 +00:00
109 lines
6.8 KiB
Markdown
109 lines
6.8 KiB
Markdown
# The Homebrewery
|
|
|
|
Welcome traveler from an antique land. Please sit and tell us of what you have seen. The unheard of monsters, who slither and bite. Tell us of the wondrous items and and artifacts you have found, their mysteries yet to be unlocked. Of the vexing vocations and surprising skills you have seen.
|
|
|
|
### Homebrew D&D made easy
|
|
The Homebrewery makes the creation and sharing of authentic looking Fifth-Edition homebrews easy. It uses [Markdown](https://help.github.com/articles/markdown-basics/) with a little CSS magic to make your brews come to life.
|
|
|
|
**Try it!** Simply edit the text on the left and watch it *update live* on the right.
|
|
|
|
|
|
|
|
### Editing and Sharing
|
|
When you create your own homebrew you will be given a *edit url* and a *share url*. Any changes you make will be automatically saved to the database within a few seconds. Anyone with the edit url will be able to make edits to your homebrew. So be careful about who you share it with.
|
|
|
|
Anyone with the *share url* will be able to access a read-only version of your homebrew.
|
|
|
|
## Helping out
|
|
Like this tool? Want to buy me a beer? [Head here](https://www.patreon.com/Naturalcrit) to help me keep the servers running.
|
|
|
|
This tool will **always** be free, never have ads, and I will never offer any "premium" features or whatever.
|
|
|
|
|
|
|
|
>##### PDF Exporting
|
|
> PDF Printing works best in Chrome. If you are having quality/consistency issues, try using Chrome to print instead.
|
|
>
|
|
> After clicking the "Print" item in the navbar a new page will open and a print dialog will pop-up.
|
|
> * Set the **Destination** to "Save as PDF"
|
|
> * Set **Paper Size** to "Letter"
|
|
> * If you are printing on A4 paper, make sure to have the "A4 page size snippet" in your brew
|
|
> * In **Options** make sure "Background Images" is selected.
|
|
> * Hit print and enjoy! You're done!
|
|
>
|
|
> If you want to save ink or have a monochrome printer, add the **Ink Friendly** snippet to your brew before you print
|
|
|
|
|
|
```
|
|
```
|
|
|
|
## V3.0.0 Released!
|
|
With the latest major update to *The Homebrewery* we've implemented an extended Markdown-like syntax for block and span elements, plus a few other changes, eliminating the need for HTML tags like **div** and **span** in most cases. No raw HTML tags should be needed in a brew, and going forward, raw HTML will no longer receive debugging support (*but can still be used if you insist*).
|
|
|
|
**You can enable V3 via the <span class="fa fa-info-circle" style="text-indent:0"></span> Properties button!**
|
|
|
|
## New Things All The Time!
|
|
What's new in the latest update? Check out the full changelog [here](/changelog)
|
|
|
|
### Bugs, Issues, Suggestions?
|
|
Take a quick look at our [Frequently Asked Questions page](/faq) to see if your question has a handy answer.
|
|
|
|
Need help getting started or just the right look for your brew? Head to [r/Homebrewery](https://www.reddit.com/r/homebrewery/submit?selftext=true&title=%5BIssue%5D%20Describe%20Your%20Issue%20Here) and let us know!
|
|
|
|
Have an idea to make The Homebrewery better? Or did you find something that wasn't quite right? Check out the [GitHub Repo](https://github.com/naturalcrit/homebrewery/) to report technical issues.
|
|
|
|
### Legal Junk
|
|
The Homebrewery is licensed using the [MIT License](https://github.com/naturalcrit/homebrewery/blob/master/license). This means you are free to use The Homebrewery codebase 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 you make on this site, it's your responsibility to ensure you have the proper licenses/rights for any images or resources used.
|
|
|
|
### More Resources
|
|
<a href='https://discord.gg/by3deKx' target='_blank'><img src='/assets/discordOfManyThings.svg' alt='Discord of Many Things Logo' title='Discord of Many Things Logo' style='width:50px; float: right; padding-left: 10px;'/></a>
|
|
If you are looking for more 5e Homebrew resources check out [r/UnearthedArcana](https://www.reddit.com/r/UnearthedArcana/) and their list of useful resources [here](https://www.reddit.com/r/UnearthedArcana/wiki/resources). The <a href='https://discord.gg/by3deKx' target='_blank' title='Discord of Many Things'>Discord of Many Things</a> is another great resource to connect with fellow homebrewers for help and feedback.
|
|
|
|
<img src='https://i.imgur.com/hMna6G0.png' style='position:absolute;bottom:40px;right:30px;width:280px' />
|
|
|
|
<div class='pageNumber'>1</div>
|
|
<div class='footnote'>PART 1 | FANCINESS</div>
|
|
|
|
<div style='position: absolute; top: 20px; right: 20px;'>
|
|
<a href='https://discord.gg/by3deKx' target='_blank' title='Discord of Many Things'><img src='/assets/discord.png' style='height:30px'/></a>
|
|
<a href='https://github.com/naturalcrit/homebrewery' target='_blank' title='Github' style='color: black; padding-left: 5px;'><img src='/assets/github.png' style='height:30px'/></a>
|
|
<a href='https://patreon.com/NaturalCrit' target='_blank' title='Patreon' style='color: black; padding-left: 5px;'><img src='/assets/patreon.png' style='height:30px'/></a>
|
|
<a href='https://www.reddit.com/r/homebrewery/' target='_blank' title='Reddit' style='color: black; padding-left: 5px;'><img src='/assets/reddit.png' style='height:30px'/></a>
|
|
</div>
|
|
|
|
\page
|
|
|
|
# Appendix
|
|
|
|
### Not quite Markdown
|
|
Although the Homebrewery uses Markdown, to get all the styling features from the PHB, we had to get a little creative. Some base HTML elements are not used as expected and I've had to include a few new keywords.
|
|
|
|
___
|
|
* **Horizontal Rules** are generally used to *modify* existing elements into a different style. For example, a horizontal rule before a blockquote will give it the style of a Monster Stat Block instead of a note.
|
|
* **New Pages** are controlled by the author. It's impossible for the site to detect when the end of a page is reached, so indicate you'd like to start a new page, use the new page snippet to get the syntax.
|
|
* **Code Blocks** are used only to indicate column breaks. Since they don't allow for styling within them, they weren't that useful to use.
|
|
* **HTML** can be used to get *just* the right look for your homebrew. I've included some examples in the snippet icons above the editor.
|
|
|
|
|
|
|
|
```
|
|
```
|
|
|
|
|
|
### Images
|
|
Images must be hosted online somewhere, like imgur. You use the address to that image to reference it in your brew. Images can be included 'inline' with the text using Markdown-style images. However for background images more control is needed.
|
|
|
|
Background images should be included as HTML-style img tags. Using inline CSS you can precisely position your image where you'd like it to be. I have added both a inflow image snippet and a background image snippet to give you exmaples of how to do it.
|
|
|
|
|
|
|
|
### Crediting Me
|
|
If you'd like to credit The Homebrewery in your brew, I'd be flattered! Just reference that you made it with The Homebrewery.
|
|
|
|
|
|
|
|
<div class='pageNumber'>2</div>
|
|
<div class='footnote'>PART 2 | BORING STUFF</div>
|