Giter Club home page Giter Club logo

homebrewery-standalone's Introduction

Homebrewery (standalone)

NOTE: This is project isn't receiving any updates. See here.

Homebrewery is a tool for making authentic looking D&D content using only Markdown.

This is a trimmed-down version of Homebrewery that uses Mithril.js (instead of React) and puppeteer to make PDF files.

Quick Start

This will be updated eventually with more information.

  1. Clone this repository
  2. Open a shell in the repo dir and install dependencies (npm install)
  3. Run the tool on the test file (npm run hb -- test.md test.pdf)

License

This project is licensed under MIT. 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.

homebrewery-standalone's People

Contributors

dependabot[bot] avatar tcyrus avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

homebrewery-standalone's Issues

Problem with monster stat block

When inserting a monster stat block, first part of the table is centered instead of left aligned.

___
> ## Mad Koala of the West
>*Tiny fiend, chaotic gossipy*
> ___
> - **Armor Class** 20
> - **Hit Points** 98(1d4 + 5)
> - **Speed** 29ft.
>___
>|STR|DEX|CON|INT|WIS|CHA|
>|:---:|:---:|:---:|:---:|:---:|:---:|
>|16 (+3)|4 (-3)|13 (+2)|2 (-4)|14 (+2)|7 (-1)|
>___
> - **Condition Immunities** buzzed, groggy, drunk
> - **Senses** passive Perception 7
> - **Languages** Latin, Common
> - **Challenge** 4 (7978 XP)
> ___
> ***Pack Tactics.*** These guys work together. Like super well, you don't even know.
>
> ***Fowl Appearance.*** While the creature remains motionless, it is indistinguishable from a normal chicken.
>
> ***Pack Tactics.*** These guys work together. Like super well, you don't even know.
> ### Actions
> ***Tilt-a-whirl Eye Takedown.*** *Melee Weapon Attack:* +4 to hit, reach 5ft., one target. *Hit* 5 (1d6 + 2) 
>
> ***Corkscrew Strike.*** *Melee Weapon Attack:* +4 to hit, reach 5ft., one target. *Hit* 5 (1d6 + 2) 


image

Add Installation + Usage Instructions to README

It's cool that this comes with a test markdown file, but the README includes no instructions for running it.

I'm not a JS developer, so running JS as an executable is very much a mystery to me.

Significant Rewrite

The rendering code as well as the stylesheet for homebrewery has gone through significant changes. The easiest way that I see this playing out is:

  • Translating components from React to lightweight TSX compatible alternative (Preact, nano-tsx, SolidJs, etc)
  • Rewriting the LESS stylesheets (to handle assets)
  • Investigate better way to link to offline fonts (link to dependencies?)
  • Investigate using ThemeProvider instead of current css loading system
  • Attempt to handle assets using puppeteer (to minimize CSS size)

This is a lot of work, given how significantly they've changed the asset loading process with themes.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.