Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/grislyeye/vellum-monster

Web component for displaying 5th Edition monster stat blocks
https://github.com/grislyeye/vellum-monster

armor attack-bonus challenge-rating css custom-theme custom-themes dnd dnd5e html javascript lit-element lit-html monster npc rpg stat-blocks stats theme vellum-monster webcomponents

Last synced: 19 days ago
JSON representation

Web component for displaying 5th Edition monster stat blocks

Awesome Lists containing this project

README 

        
# <vellum-monster> [![Build Status](https://github.com/grislyeye/vellum-monster/actions/workflows/node.js.yml/badge.svg)](https://github.com/grislyeye/vellum-monster/actions/workflows/node.js.yml)



Web component for displaying monster stat blocks for the fifth edition of the world's most popular table-top roleplaying game. Based on [Val Markovic's Statblock5e](https://valloric.github.io/statblock5e/) but with the following, additional features:



  * Simpler (just one import vs 5)

  * Theme-able

  * Automatically calculate values (average hit points and challenge rating)



To install:



```sh

npm install --save vellum-monster

```



You can also use the CDN:



```html



```



![Simple Screenshot](demo/warhorse-screenshot.png)



The above stat block is written as follows:



```html



```



This module also includes a theme to give your stat blocks a more "official" look. Simply add the following to your HTML file `head` element:



```html



```



### Calculating Challenge Rating



If you do not provide the challenge rating for your monster, `` will attempt to automatically calculate and fill this value in for you, based on armor class, hit points, damage and attack bonus.



Traits, actions, reactions and legendary actions can adjust the effective value of these stats when calculating challenge rating. Each of these objects of can declare a `hpAdjustment`, `acAdjustment`, `damageAdjustment` or `attackAdjustment` which can increase or decrease the effective hit points, armor class, damage or attack bonus when calculating CR.



## Custom Themes



To create a custom theme for your stat blocks using something like the following CSS:



```css

html vellum-monster.my-theme,

html vellum-stat-block.my-theme {



  // custom styles here



}

```



You can then add standard CSS. The `` and `` support the following custom CSS properties:



| Property                               | Description

| -------------------------------------- | ---

| `--stat-block-width`                   | Describes the width property for the stat block, as per the [CSS `width` property](https://developer.mozilla.org/en/docs/Web/CSS/width).

| ` --stat-block-background`             | Describes the background property for the stat block body, as per the [CSS `background` property](https://developer.mozilla.org/en/docs/Web/CSS/background).

| `--stat-block-bar-border`              | Describes the border property for top and bottom stat block bars, as per the [CSS `border` property](https://developer.mozilla.org/en/docs/Web/CSS/border).

| ` --stat-block-bar-background`         | Describes the background property for top and bottom stat block bars, as per the [CSS `background` property](https://developer.mozilla.org/en/docs/Web/CSS/background).

| `--stat-block-border-color`            | The [colour](https://developer.mozilla.org/en-US/docs/Web/CSS/color) for the stat block borders on the right and left.

| `--stat-block-header-color`            | The [colour](https://developer.mozilla.org/en-US/docs/Web/CSS/color) of the section headings and stat block header text.

| `--stat-block-heading-font-family`     | The [font-family](https://developer.mozilla.org/en-US/docs/Web/CSS/font-family) of the section headings and stat block header text.

| `--stat-block-divider-color`           | The [colour](https://developer.mozilla.org/en-US/docs/Web/CSS/color) of the divider between sections of the stat block.

| `--stat-block-two-column-width`        | If the `two-column` class is applied to the stat block, this defines the width of the wider stat block.

| `--stat-block-two-column-column-width` | If the `two-column` class is applied to the stat block, this defines the width of the width of the columns within the stat block.



See the [official theme](https://github.com/grislyeye/vellum-monster/blob/master/themes/official/style.css) for an example of how to style your stat blocks



## Custom Stat Blocks



The `` element allows you to create custom stat-blocks layouts. This could be for information that doesn't conform to the stand monster stat block, such as [location stat blocks](https://imgur.com/a/aIVfv). Or to represent non-standard information the `` element doesn't yet support.



For example:



```html



  Test Stat Value 1



  



  Test Stat Value 2



```



**Note:** Users are encouraged `` element for monster descriptions wherever possible, and [raise bugs](https://github.com/grislyeye/vellum-stat-block/issues/new) where it doesn't support what you want to do. Rather than fall-back to the ``.



## NPC Stat Blocks



The `` element allows you to display a NPC in more roleplaying terms and is a work in progress.



## Hacking



Requirements:



  * [Node.js](http://nodejs.org/)



To set-up your environment execute:



    $ npm install



To run demo page:



    $ npm run start



To run tests execute:



    $ npm test



To run the tests you need to have Java 8 installed.



## Rights



This software is copyrighted by Ricardo Gladwell and Val Markovic 2014-2018. It is licensed under the [Apache License, Version 2.0](LICENSE.txt). All monster statistics are Open Game Content and licensed under the [Open Gaming License](OGL.txt).