grislyeye/vellum-monster

Web component for displaying 5th Edition monster stat blocks

vellum-monster's Issues

Top bar should be slightly wider that content body box

Stat block should be slightly wider than the content body box.

Upgrade to Polymer 3

Upgrade to Polymer 3 when it is released.

Add support for paragraphs in action/trait descriptions

Paragraphs are not currently supported in <vellum-stat> action/trait descriptions. This needs to be fixed

Automatically calculate average hit points

Based on the monster's hitDie attribute we should automatically calculate the average hit points (hp) if this value is not provided.

Automatically apply ability score bonuses to armor

Automatically apply ability score bonuses to armor.

For example, let's say we have the following:

              <vellum-monster
                id="monster"
                name="Monster"
                named="true"
                size="Small"
                type="fey"
                alignment="chaotic neutral"
                baseAc="10"
                armor="natural armor"
                hit-die="2d6 - 2"
                speeds='["30 ft.","swim 30ft."]'

                str="10"
                dex="14"
                con="8"
                int="13"
                wis="10"
                cha="15"

This would display as as an effective/actual AC of 10 (baseAc + Dex Modifier of +2).

This would need to be supported with a default ac attribute which allows users to ignore calculations and force the monster's AC.

Average hitpoints rounding up instead of down

Hit points calculations are rounding up instead of down, e.g. a creature with hit dice 3d6 - 2 shoul dhave average hit points of 8. We are calculating them as 9

Add monster schema to web site

Add a schema.org-style schema page for monsters to web site.

Add linting (JS, HTML, etc.)

Add linting to the build process for:

• Polymer
• JavaScript
• CSS
• HTML

Automatically calculate challenge rating

Based on the monster's stats we should automatically calculate a monster's challenge rating (cr) if this value is not provided.

This may need additional work so as to add new attributes to accuractely determine CR (i.e. whether the monster can fly, etc.).

Add Storybook documentation site

Add documentation to custom elements using Storybook:

https://storybook.js.org/

Hit points not displaying when specified

Hit points are not displaying when they are specified.

Add semantic data

Add semantic data to stat-block element so that it can be parsed by other software (i.e. to calculate CRs, etc.)

Add CI build

Add CI build (and badge) to verify errors

Copy HTML tags in <vellum-stat> bodies

HTML tags are stripped from the bodies of <vellum-stat>. We should copy HTML tags so that stats are displayed with, for example, italicised emphasis.

Allow limited usage on attacks

Currently limited usages are supported for actions only, and not attacks. For example:

<dl itemscope itemprop="actions">
  <dt>Name</dt><dd itemprop="name">Warping Blow</dd>
  <dt>Limited Usage</dt><dd itemprop="limitedUsage">Recharge 5-6</dd>
  <dt>Reach</dt><dd itemprop="reach">5ft.</dd>
  <dt>Attack Type</dt><dd itemprop="type">melee-attack</dd>
  <dt>Target</dt><dd itemprop="target">one target</dd>
  <dt>Damage</dt><dd itemprop="damage">3 (0 + 3)</dd>
  <dt>Damage Type</dt><dd itemprop="damageType">bludgeoning</dd>
</dl>

Displays as:

Support different types of multiattack

At the moment the multiattack action only supports multiples of a single attack. We would like to support different types in one action.

Something like this:

"multiAttacks": [
  {
    "id": "knife",
    "number": "2"
   },
  {
    "id": "bite",
   }
]

An in-range update of lit-element is breaking the build 🚨

---

☝️ Important announcement: Greenkeeper will be saying goodbye 👋 and passing the torch to Snyk on June 3rd, 2020! Find out how to migrate to Snyk and more at greenkeeper.io

---

The dependency lit-element was updated from 2.2.1 to 2.3.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

lit-element is a direct dependency of this project, and it is very likely causing it to break. If other packages depend on yours, this update is probably also breaking those in turn.

Status Details

• ❌ continuous-integration/travis-ci/push: The Travis CI build failed (Details).

---

Commits

The new version differs by 144 commits.

• 0eda741 Prepare 2.3.0 release (#933)
• 5a421e1 Fix formatting of new decorator for consistency (#934)
• 61d9583 Merge pull request #925 from ianwith/fix-docs
• b8b9f74 Prepare 2.3.0-pre.1 release
• 38a8b85 Removes index signature from PropertyDeclaration (#929)
• 6a4c94f Fix static property for closure (#926)
• 9060da0 Correct docs: styles - CSS inheritance
• e0dcd75 Add extra type information to help closure with type of static property. (#923)
• 8055b93 Merge pull request #914 from Polymer/customize-properties
• 90c85a5 Address review feedback.
• 8f5815f Update comment.
• ec9048b Fix spacing.
• def6df1 Fix spacing.
• 297b8b2 Address review feedback.
• 734adc5 Adds API doc for createPropertyDescriptor

There are 144 commits in total.

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

---

Your Greenkeeper Bot 🌴

Automatically calculate attack and damage bonuses

Automatically calculate attack and damage bonuses from ability score modifiers.

For example, if a Strength +3 monster has an attack defined without attack bonus or damage as follows:

                  {
                    "name": "Dagger",
                    "type": "melee-or-ranged-attack",
                    "reach": "5ft.",
                    "range": "20/60 ft.",
                    "target": "one target",
                    "damageDie": "2d4",
                    "damageType": "slashing"
                  }

We end up with actual attack bonus of +5 and a damage of 2d4+4.

Add textures to official theme

Add Monster Manual-like textures to the stat block backgrounds, including the top bar.

Convert to open-wc

Convert project to use open-wc testing and linting frameworks.

Gap appearing above bottom bar on Firefox

A gap is appearing above the bottom bar. This only appears to occur on Firefox. Maybe be related to an absolutely positioned image in the back ground:

Automatically calculate XP based on CR

Based on the monster's challenge rating (cr) attribute we should automatically calculate a monster's experience points (xp) if this value is not provided.

Tests failing on desktop and CI

The end-to-end tests on desktop and front-end appear to be broken:

https://travis-ci.org/grislyeye/vellum-monster/builds/539441074

Add linting (JS, HTML, etc.)

Add linting to the build process for:

• Polymer
• JavaScript
• [ ] CSS
• [ ] HTML

vellum-monster uses calculated CR even when CR is passed

Given the following HTML:

<vellum-monster
  hp="200"
  ac="18"
  cr="2"
  xp="450"
></vellum-monster>

Expected behavior:
It will display the following text in the stat block:

Armor Class 18
Hit Points 200
Challenge 2 (450 XP)

Actual behavior:
It will display the following text in the stat block:

Armor Class 18
Hit Points 200
Challenge 4 (450 XP)

Thank you a lot for all of the time and work you put into this project!

Fix stat blocks splitting columns in Chrome

Stat blocks can split across columns in Chrome:

Fix stat blocks splitting columns in Chrome

Stat blocks can split across columns in Chrome:

Convert to Typescript

An in-range update of eslint-config-standard is breaking the build 🚨

---

☝️ Important announcement: Greenkeeper will be saying goodbye 👋 and passing the torch to Snyk on June 3rd, 2020! Find out how to migrate to Snyk and more at greenkeeper.io

---

The devDependency eslint-config-standard was updated from 14.1.0 to 14.1.1.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

eslint-config-standard is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

• ❌ continuous-integration/travis-ci/push: The Travis CI build failed (Details).

---

Commits

The new version differs by 7 commits.

• 3f4a3fe 14.1.1
• 2a14319 Merge pull request #164 from standard/remove-no-return-await
• 243d38f Remove no-return-await rule
• eb187de chore: .npmrc with package-lock=false (#155)
• dcf95fe chore: .npmrc with package-lock=false
• e5e81a8 Merge pull request #153 from standard/greenkeeper/eslint-plugin-node-10.0.0
• 83ba3be chore(package): update eslint-plugin-node to version 10.0.0

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

---

Your Greenkeeper Bot 🌴

Suggestion: Omit fields given an empty array

Hello, thank you again for all of your hard work on this project.

I have a suggestion:

In textual data representations, empty arrays are often used to represent empty to-many relationships. (one such example)
A monster's immunities or reactions would be two cases of a to-many relationship. They can have anywhere between 0 and many immunities and/or reactions.
In vellum-monster, if an empty array is passed to a field expecting an array, such as immunities or reactions, it will still show the Immunities or Reactions text, even though they have no content.

My suggestion would be to hide these fields in the end result if the content passed to them is empty.

Given the following HTML:

<vellum-monster>
  hp="200"
  ac="18"
  immunities='[]'
  reactions='[]'
</vellum-monster>

Current outcome:

Hit Points 200
Armor Class 18
Damage Immunities

Reactions

Suggested outcome:

Hit Points 200
Armor Class 18

Thank you again for your work! Let me know what you think!

Add Polymer API documentation

Add Polymer API documentation to custom elements.

Create more generic `<vellum-stat-block>`

Separate the <vellum-stat-block> into <vellum-stat-block> and <vellum-monster>:

• <vellum-stat-block> generic stat-block style container for any "thing", like locations, NPCS etc.
• <vellum-monster> for standard monster stat blocks, as per the "old" <vellum-stat-block>

Add drop shadow to official theme

Add stat block drop shadow to official them.

Upgrade to use LitElement

Upgrade from Polymer 3 (deprecated) to use LitElement/lit-html.

Incorrect defensive CR calculation

Effective AC CR is being calculated incorrectly. Given a monster with 9 HP and AC 16 we get:

	Value	Effective CR
HP	9	⅛
AC	16	+1

But the effective defensive CR for the AC should be +5.

Top bar should be slightly wider that content body box

Stat block should be slightly wider than the content body box.

Add textures to official theme

Add Monster Manual-like textures to the stat block backgrounds, including the top bar.

Add tests

Add unit tests as described here:

https://www.polymer-project.org/1.0/docs/tools/tests

Copy HTML tags in <vellum-stat> bodies

Add monster schema to web site

Add a schema.org-style schema page for monsters to web site.

Add screenshots / demo to readme

Arguably the most important thing about this is what it looks like.

If you want others to use / contribute, I recommend adding a demo / image / gif in the readme.

Allow limited usage on attacks

Currently limited usages are supported for actions only, and not attacks. For example:

<dl itemscope itemprop="actions">
  <dt>Name</dt><dd itemprop="name">Warping Blow</dd>
  <dt>Limited Usage</dt><dd itemprop="limitedUsage">Recharge 5-6</dd>
  <dt>Reach</dt><dd itemprop="reach">5ft.</dd>
  <dt>Attack Type</dt><dd itemprop="type">melee-attack</dd>
  <dt>Target</dt><dd itemprop="target">one target</dd>
  <dt>Damage</dt><dd itemprop="damage">3 (0 + 3)</dd>
  <dt>Damage Type</dt><dd itemprop="damageType">bludgeoning</dd>
</dl>

Displays as:

Automatically calculate hit die based on size and Constitution

We can automatically calculate hit die based on size and Constitution. For this we will need a new attribute, something like numberOfHitDie and we can calculate the rest by determing dice from size (Small is d6, etc.) and modifier from Constitution score (numberOfHitDie * Cons modifier).

Automatically calculate skills/saves/weapon bonuses

Automatically calculate skills/saves/weapon bonuses if new proficiency stat is present.

Remove dependency on deprecated Polymer tooling

Polymer has been deprecated, and our depedency on the unsupported polymer CLI is causing issues:

#37

We should find another way to run the component tests in a browers outside of the polymer test CLI.

Fix stat blocks splitting columns in Chrome

Stat blocks can split across columns in Chrome:

Support for spell attacks

Some attacks are spell attacks (ranged and melee). We should support these using the new attack types ranged-spell-attack, melee-spell-attack and melee-or-ranged-spell-attack.

Add CDN library for use in static web sites

Add CDN script library so that stat-blocks can be easily used in other web sites, even from markdown!

Add drop shadow to official theme

Add stat block drop shadow to official theme

Support damage for non-attack actions

Add support for damage and attack bonuses for non-attack actions, and spell-like actions.

For example, the action:

{
    "name": "Shadow Rift (1/day)",
    "id": "shadow-rift",
    "description": "The Gloaming Queen can open a rift to the abyss in a 20-foot sphere centred on a point she can see within 120 feet. Any creature within the rift takes 10d8 necrotic damage, or half damage with a successful DC 14 Constitution saving throw."
  }

There should be a method to define the damage and saving throw for this action so that CR can be correctly calculated.