open5e-api icon indicating copy to clipboard operation
open5e-api copied to clipboard

Monsters missing descriptions

Open michaeleconomy opened this issue 5 years ago • 4 comments

So in this file: https://github.com/eepMoody/open5e-api/blob/master/data/WOTC_5e_SRD_v5.1/monsters.json

I'd expect it to contain the descriptions for monsters from here: https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf (not all monsters have descriptions, but a lot of them do).

In case me or someone else gets motivated to fix this: Did you generate the JSON file by hand? or by parsing the pdf?

What should the name of the description property be? ("description" is nice and clear, but "desc" is more consistent with the rest of the file).

michaeleconomy avatar Nov 21 '19 01:11 michaeleconomy

I'm not sure I'm seeing which monsters have descriptions. Cursory scrolling through the first half I didn't see any.

As for the text, the original was made by parsing the PDF, but since then it's been extensively hand-edited.

eepMoody avatar Nov 21 '19 04:11 eepMoody

As for any that are there, I'd want to stick with "desc" for consistency.

eepMoody avatar Nov 21 '19 04:11 eepMoody

So weird - there's only 7 or so, kinda makes you think it was like a copy paste error by wizards.

michaeleconomy avatar Nov 21 '19 05:11 michaeleconomy

Yeah. I notice they're concentrated in the animals/beasts appendix. Maybe they just did that differently, or are intended to create more for the other monsters eventually.

On Thu, Nov 21, 2019 at 12:41 AM Michael Economy [email protected] wrote:

So weird - there's only 7 or so, kinda makes you think it was like a copy paste error by wizards.

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/eepMoody/open5e-api/issues/44?email_source=notifications&email_token=ABPJY7K2DTBO7GGNVSOHHCDQUYNQLA5CNFSM4JP3YQ52YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEEZBDKY#issuecomment-556929451, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABPJY7MAUT4ASSFL3CU45P3QUYNQLANCNFSM4JP3YQ5Q .

eepMoody avatar Nov 21 '19 15:11 eepMoody

As of right now, there is no field in the model for "description" of a monster.

"awakened tree" is an example in the SRD that has a short description (after the actions section).

I believe a technical enhancement to store a description at a monster level,would be required, then the corresponding import and data changes to consume the field correctly.

augustjohnson avatar Mar 18 '23 12:03 augustjohnson

And of course, we'd need the actual data.

augustjohnson avatar May 13 '23 13:05 augustjohnson

To spec out this work:

  • [x] Identify the total list of creatures that have a description. (These appear to be almost completely concentrated in the Appendx MM-A of the srd).
  • [x] Translate the text descriptions into markdown (it appears as though Bold is about it).
  • [x] Update the /data/srd/montsters.json document to include a desc field with a markdown.
  • [x] Update the monster importer to pull desc as well.
  • [x] The model should already support this (inheriting it from gamecontent) so the technical step is going to be expose it through the serializer, and maybe adding a filter? Probably adding it to searchindex as well.

augustjohnson avatar May 14 '23 15:05 augustjohnson

There's lots of entries in MM-B as well for the NPCs.

  • [x] Add descriptions to docs for NPCs.

augustjohnson avatar May 14 '23 15:05 augustjohnson

Here is the total list of slugs of things SRD that have descriptions. 47 items.

Awakened-shrub Awakened-tree Axe-beak Blink-dog Blood-hawk Death-dog Flying-snake frog Giant-eagle Giant-elk Giant-fire-beetle Giant-lizard Giant-owl Giant-poisonous-snake Giant-sea-horse Giant-shark Giant-spider Giant-wolf-spider Hunter-shark mammoth mastiff Phase-spider quipper Reef-shark Winter-wolf worg acolyte archmage assassin bandit Bandit-captain berserker commoner cultist Cult-fanatic druid gladiator guard knight mage noble priest scout spy thug Tribal-warrior veteran

augustjohnson avatar May 17 '23 01:05 augustjohnson