[Script] D&D 5e Shaped NPC & Spell Importer

1. Be a mentor
2. Create 3 API files in your campaign settings -> API scripts page. 5e-monsters, 5e-spells, and 5e-scripts.
3. Copy the script from github (open it in RAW) to 5e-scripts
4. Click save
5. In the Output console on the same page it should print out "Shaped Scripts ready"
6. Enter data for monsters and spells as outlined below. See github for examples.
7. Save both files
8. Select a token
9. Run a command like "!shaped-spell --fireball" or "!shaped-spell --fireball, magic missile". Or import commands like "!shaped-monster --goblin".

fifthMonsters = {
  monsters: [
    {
      "name": "Goblin",
      "size": "Small",
      "type": "humanoid (goblinoid)",
      "alignment": "neutral evil",
      "AC": "15 (leather armor, shield)",
      "HP": "7 (2d6)",
      "speed": "30 ft.",
      "abilities": "STR 8 DEX 14 CON 10 INT 10 WIS 8 CHA 8",
      "skills": "Stealth +6",
      "senses": "darkvision 60 ft., passive Perception 9",
      "languages": "Common, Goblin",
      "challenge": "1/4",
      "traits": [
        "Nimble Escape. The goblin can take the Disengage or Hide action as a bonus action on each of its turns."
      ],
      "actions": [
        "Scimitar. Melee Weapon Attack: +4 to hit, reach 5 ft., one target. Hit: 5 (1d6 + 2) slashing damage.",
        "Shortbow. Ranged Weapon Attack: +4 to hit, range 80/320 ft., one target. Hit: 5 (1d6 + 2) piercing damage."
      ]
    }
  ]
};

fifthSpells = {
  spells: [
    {
      "name": "Fireball",
      "description": "A bright streak flashes from your pointing finger to a point you choose within range and then blossoms with a low roar into an explosion of flame. Each creature in a 20-foot-radius sphere centered on that point must make a Dexterity saving throw. A target takes 8d6 fire damage on a failed save, or half as much damage on a successful one.\nThe fire spreads around corners. It ignites flammable objects in the area that aren't being worn or carried.",
      "higherLevel": "When you cast this spell using a spell slot of 4th level or higher, the damage increases by 1d6 for each slot level above 3rd.",
      "emote": "evokes a bright streak that flashes from {{GENDER_PRONOUN_HIS_HER}} pointing finger to a point and then blossoms with a low roar into an explosion of flame",
      "source": "phb 241",
      "range": "150 ft",
      "target": "each creature in the aoe",
      "aoe": "20 ft radius sphere centered on a point within range",
      "components": {
        "verbal": true,
        "somatic": true,
        "material": true,
        "materialMaterial": "A tiny ball of bat guano and sulfur"
      },
      "duration": "Instantaneous",
      "castingTime": "action",
      "level": 3,
      "school": "Evocation",
      "save": {
        "ability": "dexterity",
        "damage": "8d6",
        "damageType": "fire",
        "saveSuccess": "half damage",
        "higherLevelDice": "1",
        "higherLevelDie": "d6"
      },
      "effects": "The fire spreads around corners. It ignites flammable objects in the area that aren't being worn or carried.",
      "classes": [
        "Cleric",
        "Sorcerer",
        "Warlock",
        "Wizard"
      ],
      "domains": [
        "Light"
      ],
      "patrons": [
        "Fiend"
      ]
    }
  ]
};

Fencer
Medium beast, neutral
Armor Class 8 (armor scraps)
Hit Points 13 (2d8 + 4)
Speed 30ft., burrow 20 ft., climb 80ft, fly 40ft. (hover), swim 150ft
STR 10 (+0)
DEX 14 (+2)
CON 15 (+2)
INT 6 (-2)
WIS 8 (-1)
CHA 5 (-3)
Damage Resistances radiant
Damage Vulnerabilities bludgeoning
Damage Immunities poison
Condition Immunities exhaustion, poisoned
Senses blindsight 30ft. (blind beyond this radius), darkvision 60ft, tremorsense 20ft., truesight 5ft, passive Perception 9
Languages understands all languages it knew in life but can't speak
Challenge 1/4 (50 XP)
Actions
Shortsword. Melee Weapon Attack: +4 to hit, reach 5 ft., one target. Hit: 5 (1d6 + 2) slashing damage.
Shortbow. Ranged Weapon Attack: +4 to hit, range 80/320 ft., one target. Hit: 5 (1d6 + 2) bludgeoning damage.
Javelin. Melee or Ranged Weapon Attack: +5 to hit, reach 5 ft. or range 30/120 ft., one target. Hit: 6 (1d6 + 3) acid damage.
Bites. Melee Weapon Attack: +4 to hit, reach 0 ft., one creature in the swarm's space. Hit: 5 (2d4) piercing damage, or 2 (1d4) piercing damage if the swarm has half of its hit points or fewer.
Snake Bites. Melee Weapon Attack: +6 to hit, reach 0 ft., one creature in the swarm's space. Hit: 7 (2d6) piercing damage, or 3 (1d6) piercing damage if the swarm has half of its hit points or fewer. The target must make a DC 10 Constitution saving throw, taking 14 (4d6) poison damage on a failed save, or half as much damage on a successful one.
Poisoned Bite. Melee Weapon Attack: +4 to hit, reach 5 ft., one creature. Hit: 1 piercing damage, and the target must succeed on a DC 9 Constitution saving throw or take 2 (1d4) poison damage.
Petrifying Gaze. If a creature starts its turn within 30 feet of the basilisk and the two of them can see each other, the basilisk can force the creature to make a DC 12 Constitution saving throw if the basilisk isn't incapacitated. On a failed save, the creature magically begins to turn to stone and is restrained. It must repeat the saving throw at the end of its next turn. On a success, the effect ends. On a failure, the creature is petrified until freed by the greater restoration spell or other magic.
Tentacle. Melee Weapon Attack: +9 to hit, reach 10ft., one target. Hit: 12 (2d6 + 5) bludgeoning damage. If the target is a creature, it must succeed on a DC 14 Constitution saving throw or become diseased. The disease has no effect for 1 minute and can be removed by any magic that cures disease. After 1 minlilte, the diseased creature's skin becomes translucent and slimy, the creature can't regain hit points unless it is underwater, and the disease can be removed only by heal or another di sease-curing spell of 6th level or higher. When the creature is outside a body of water, it takes 6 (1d12) acid damage every 10 minutes unless moisture is applied to the skin before 10 minutes have passed.

1. See Install above
2. Launch your campaign
3. Open the token's properties and in the "GM Notes" section paste the creature's stat block from the MM
4. Select the token
5. In the chat type !shaped-import (or !build-monster or !shaped-parse) ("!shaped import --clean" will recreate the whole sheet)
6. Wallah! (You'll see log details back on the API scripts page)

RMcD said:

"
The importer will fix many many common errors. For example ldX will be converted to 1dX before parsing and spaces in many words will be removed ("slash ing" becomes "slashing". The list is ever expanding)."

Hold on, is this not better than the other importer? I don't remember it fixing that.

1. "Random" hp does indeed never take below average which does make the game harder. That is from JF's script. I'll make it take real average.
2. Converting doesn't parse actions. Actions from the old parser are all cut up. I'll do some exploring to see if what is parsed from JF's script can be used otherwise I'll put in a command to just import the Actions (would require putting the Actions in gm notes)
3. It does for import. Does it not for converting? I'll add it.
4. I'll fix the bars. They were working for me when I checked, but I didn't extensively test.

• You can now specify the default tab for a sheet.
• You can now specify the default settings for the "Settings" tab in the script.
• Changed the default to not use the average hp as a minimum
• Printed out a log message when a creature is done converting.
• Imported JF's 2.4 changes to this script

1. Convert/Reimport Actions. Hopefully convert. Will be a problem with multiattack - I will try to work around it.
2. Test bars. Fix any bugs.

• Fix bars to take the correct values for converting
• Fix convert to work with creatures whose name is different from their journal names (gets the journal via "represents")

• Added the option to default bars to the attribute set in the settings. (Works on Importing and Converting)
• Added the option to show the token's name by default. Can be turned off.
• Fixed bars more after some additional testing
• Converting of Actions is now done. The text is processed back into the expected format from the book and then processed.
• Any item set as "Action", "Bonus Action", or "Special Action" is set to a normal action. Reactions will go to the reaction box. Lair and Legendary actions are converted appropriately.
• Speeds were converted properly now
• Visions (Darkvision, Blindsight, etc) were converted properly now
• Saves and Skills now use Proficiency or Expertise if applicable. They will calculate the offset and set it to a bonus if needed.
• NPC Actions now set the multiattack checkbox if the attack is part of the multiattack.
• Saves with "Within # feet" now add that # to range.
• Recharge is now processed from actions
• Line attacks are processed better now.
• Save attacks with damage are processed correctly now.

RMcD said:

Edit: damn that's ugly what's the formatting on this forum. Here's pastebin instead; http://pastebin.com/9UCnJdS6

When I tried it on my Giant Spider it kept Web (Recharge 5-6), added Web, and overwrote Bite.

The Aaron said:

RMcD said:

Edit: damn that's ugly what's the formatting on this forum. Here's pastebin instead; http://pastebin.com/9UCnJdS6

It would probably look more to your liking if you formated it as code, available in the ¶ menu at the upper left.

RMcD said:

Re: Mark, as I said since these tokens with all the GM-Notes are the same as the ones I previously parsed they have all the old information on the character sheet. Even though I switch the character sheets to Shaped instead of normal it doesn't delete any of the data including the token rolls, so because your parse doesn't attempt to delete the already existing character sheet you have both data, some overwritten, some not.

Giant Spider is copied out of the book, Lost Mine of Phandelver to be precise which is "Web (Recharge 5-6). Ranged Weapon Attack: +5 to hit, range 30 ft./60 ft., one creature", all of my stuff is from that.

If I wanted to do it your way I'd have to go and delete all the character sheets (or copy the map and not copy them over but copy all the tokens over) or remake the tokens with the GM-Notes too.

Mark said:

RMcD said:

snip

Woah woah woah, no need to get agitated - I'm here to work through the issues and I very much appreciate you bringing them up. I did not mean to be dismissive. Sorry if it came off that way.

On replacing: Are you saying there are left over abilities? If so those should be replaced with the new actions (as long as the name matches up). I assume in this case the old name has Recharge (5-6) in it? That would throw it off.
The importer was written by JF to only update some parts. I think that's a good design. In this case I think the only problem is the abilities if they are named differently. Are there any other issues you're experiencing?
I could delete all the old abilities, but that may have unintended consequences for other DMs who added their own abilities... hmmm

On LMoP: The starter set came out before the monster manual and therefore has different syntax in some areas. Primarily my goal is to support the MM syntax as most versions of LMoP around the net are not OCR'd so therefore text can't be copied so LMoP is of limited concern.
However I will also support LMoP Syntax as long as it's possible and it seems to be in this case. I will add support to parse the range from this syntax as well.
As a GM I would recommend taking the updated monsters from MM as some were adjusted, but that's entirely up to you.



I now properly parse bite and web. I will fix the range sytax to work with LMoP as well.
EDIT: Parsed the "## ft/## ft" syntax to the MM syntax in my sanitize text function.

I'll commit all the code later today.

Recharge X-Y. The notation "Recharge X- Y" means a monster can use a special ability once and that the ability then has a random chance of recharging during each subsequent round of combat. At the start of each of the monster's turns, roll a d6. If the roll is one of the numbers in the recharge notation, the monster regains the use of the special ability. The ability also recharges when the monster finishes a short or long rest.

• LMoP's range format of ## ft/## ft will now be sanitized to match the MM format of ##/## ft
• Sanitized Traits to get rid of any incorrect words.
• Combined the Damage Regex into one regex. Extensively tested Ancient Black Dragon and Giant Spider. It should work for most things. Still need to test more creatures
• Cleaned up the Save Regex
• Legendary Actions parsed to notes properly if they do not have any action.

"---- Parsing statblock ----"
"statblock: NEZZNAR THE BLACK SPIDER#Medium humanoid (elf), neutral evil#Armor Class 11 (14 with mage armor)#Hit Points 27 (6d8)#Speed 30 ft.#STR#9 (-1)#CON#10 (+0)#CHA#13 (+1)#INT#16 (+3)#WIS#14 (+2)#DEX#13 (+1)#Saving Throws int +5, Wis +4#Skills Arcana +5, Perception +4, Stealth +3#Senses darkvision 120 ft., passive Perception 14#Languages Elvish, Undercommon#Challenge 2 (450 XP)#Special Equipment. Nezznar has a spider staff.#Fey Ancestry. Nezznar has advantage on saving throws against being charmed, and magic can't put him to sleep.#Sunlight Sensitivity. Nezznar has disadvantage on attack rolls when he or his target is in sunlight.#Innate Spellcasting. Nezznar can innately cast the following spells, requiring no material components:#• At will: dancing lights#• 1/day each: darkness,faeriefire (save DC 12)#Spellcasting. Nezznar is a 4th-level spellcaster that uses intelligence as his spellcasting ability (spell save DC 13; +5 to hit with spell attacks). Nezznar has the following spells prepared from the wizard's spell list:#• Cantrips (at will): mage hand, ray offrost, shocking grasp#• 1st Level (4 slots): mage armor, magic missile, shield#• 2nd Level (3 slots): invisihility, suggestion#ACTIONS#Spider Staff. Melee Weapon Attack: +1 to hit, reach 5 ft., one target. Hit: 2 (1d6 -1) bludgeoning damage plus 3 (1d6) poison damage.#"
"Creating attribute strength"
"Creating attribute dexterity"
"Creating attribute constitution"
"Creating attribute intelligence"
"Creating attribute wisdom"
"Creating attribute charisma"
"Creating attribute size"
"Updating attribute npc_type"
"Creating attribute alignment"
"Updating attribute npc_AC_note"
{}
"Parsing was incomplete due to error(s)"
"TypeError: Cannot read property '1' of null"

"undefined:1
$[[1]]
^
SyntaxError: Unexpected token $
    at Object.parse (native)
    at evalmachine.<anonymous>:167:26
    at checkFinishedOps ("

RMcD said:
Also a lot of time when loading the campaign for the first time that day and I try shaped-convert I get "Unexpected token s" and have to restart the API.

I changed blind sight to blindsight (without updating the API as I wasn't sure if you changed it) and got the same error for the Ochre.

Spectator was the most complicated creature in LMoP

Regarding Doppelganger, it correctly says "The doppelganger makes two melee attacks." in the multiattack heading under actions however Slam is not ticked as being multiattack and so the multiattack ability says this: "%{selected|npc_action_3}" which refers to nothing there is only two actions that have filled in.

Trying with import: Ochre parses fine with the change to blindsight, the doppleganger multiattack simplys says "makes with two melee attacks", is that intended I thought it was meant to roll both of them, it does for the other stuff. And the Spectator is fine with the two issues you noted.

I am now very confused about when I tried using import and when I tried using convert, very sorry about that.

• Normal Damage (with effects)
• Normal Damage plus Secondary Damage (with effects)
• Normal Damage with Alternate Damage (with Effects)
• etc

Si said:

I played around with the other script but didn't get great results.

Your script seems to work pretty amazingly! I imported Wights and Wraiths from the online monster supplement for Rise of Tiamat with no issues at all.

It even unlinks the health bar!

Two things I have noticed.
1.) It doesn't grant the tokens sight based around dark vision automagically. Not a big deal but it would be nice.
2.) The script also doesn't create a default token for the journal entry. Again not world ending but it could be annoying if I forgot. If I want to drag an NPC out in a hurry only to find out I forgot to save the token it might be annoying.

Apart from that this is very strong work. I'm really impressed.

Now I need to decide if I want to remake all my macro's and transfer my players over to the shaped sheet..... decisons decisons

1. Vision setting automatically would be really nice! There are several issues here though now that I think about it:
   1. Overlapping of visions - how should I handle blindsight 30 and darkvision 60. A bit annoying.
   2. Darkvision is meant to be dim light in 5e. Roll20 doesn't allow for a consistent layer of dim, it dims out over time. For Darkvision 60 I use 70/-5 to estimate to the player being able to see about 60ft. Unfortunately roll20 doesn't let me make the vision not progressively get dimmer. I'll first put in an estimate and then try to make it a setting
   3. Beyond those I see the parameters in the API edit it so I'll do that.
2. I remember reading that I cannot change the default token of a journal. I will ask if anyone knows if its possible and the command if so. I agree that it would be very nice.

Senses blindsight 60ft., darkvision 120ft., passive Perception 21

• Vision is now set on the token.
• Completely revamped the damage Regex
• Parsed the other format of a line (see Ankheg)

• More Sanitize
• Completely revamped the save regexes.
• All versions of the save syntax that I know of should be working
• Processed the description of monsters that comes after actions. It's been added to "traits"

• Fixed rolling HP
• Fixed level calc to remove abs (so it can be combined with other inline rolls again)
• Fixed speed and senses parsing

• Lair Actions
• Regional Effects
• Allow effects to be whispered to the GM via a select toggle.

So after doing the converts, I don't always get the right "token" actions at the end of it, I seem to keep the ones that JF's importer started with "Bite" or whatever, and some effects will copy a breath weapon over like the winter wolf or the ankheg, but unique things like a bugbear's surprise attack dice 2d6 its tricky to make sure those aren't forgotten vs they being their all the time. The only solution I got is creating it as a Secondary Damage source named "Surprised" that i'll only apply if the conditions match, but obviously I need to set that up manually.

The multiattack that gets converted from JF's import, seems to give me one attack using the NPC Sheet and one from the Shaped NPC sheet.. its a little strange and could require some manually tweaking to adjust.

The HP roll on drop is handy, but I've got it setup for Aaron's RandomHP / Name on drop, so all my characters are named Creature %%NUMBERED%% so my players have an easy time naming them off when targeting which can also be problematic when you have a "Polar Bear 12" & a "Polar Bear 15" standing next to each other which then the names overlap and defeat the purpose.

I think using the Color icons would be way better as it wouldn't impact the amount of space needed, not sure how hard it would be to script but if a token is dropped with the same name as another token on the board assign it a unique color, repeat. Obviously only so many colors so you'd have to figure out how to adapt to having more creatures than colors by maybe appending a 1 to the end and then go back to the color wheel again, repeat.

I just tested Bugbear and it does not create a token action for "Surprise". Did you create it? The converter doesn't convert any token actions, just creates ones from the character sheet.
Though many of these trait items fit a similar pattern as actions and I should create a section to handle them. Shoving them into traits isn't a good option. I'll create a new section above actions to handle them.

The multiattack that gets converted from JF's import, seems to give me one attack using the NPC Sheet and one from the Shaped NPC sheet.. its a little strange and could require some manually tweaking to adjust.
That's... strange.. I will be sure to wipe the "multiattack" token action when converting to ensure that nothing from before remains.. It should work already though... hmm

EDIT: I tested this and it does replace any old multiattack. You'll have to be more specific.

I do like Aaron's numbered script and even tried to incorporate it in, but it was a bit too long. I did make a change a week or so ago to grab tokens by something other than name. Is it not working? Is there a problem here? I don't understand.

Aaron has given you your wish: https://app.roll20.net/forum/post/1273423/script-tokennamenumber-automatic-numbering-of-qualifying-tokens#post-1859038