Skip to content

Roll20 API for Automatically Wild Shaping using the Roll20 D&D 5th Edition OGL Sheet.

Notifications You must be signed in to change notification settings

LaytonGB/AutomaticWildShape

Repository files navigation

AutomaticWildShape

Roll20 API for Automatically Wild Shaping using the Roll20 D&D 5th Edition OGL Sheet.

NOTE: This API has not been updated in over a year. There is no guarantee it will still work.


Why This API?

I am a dedicated 5th Edition D&D player and GM. As such I wanted to craft the perfect tool for Wild Shape, one that required minimum effort from the user.

This API automatically populates its options with Beasts from the Journal. When you transform using this API, it creates you a unique sheet that follows all the D&D rules (as per D&D Beyond's Basic Rules) thereby allowing players to take both their own skill proficiencies, and those of the beast form. When you choose to revert from Wild Shape, the sheet that was created for you is deleted.

This system allows every beast to only be added once, and then every Druid or NPC can use the API to take that beast's form. The beast sheets are not affected by the API, and so they can still be used by the GM as NPCs or Monsters.


Installation

  1. You must have a Roll20 Pro subscription to use the Roll20 API.
  2. Navigate to your Roll20 game page. This should be the screen with the big game header and title.
  3. Go to Settings > API Scripts.
  4. Click "New Script".
  5. Name the script anything appropriate, and paste the contents of the AutomaticWildShape.js file into that script.
  6. Scroll down and select "Save Script".
  7. When a GM joins the campaign all macros will be automatically created.

Commands

All required commands are created in macros automatically when the API is installed. One command, "~EndWildShape", is an Ability created in the sheet of any creature currently in wild shape. These are the macros and abilities:

AutomaticWildShape - !aws / !aws <beast name>

This command is for transforming the selected token. It produces a list of appropriate CR beasts in chat that the user can click to transform into, or if submitted with a beast's name it will attempt to transform the selected token into the detailed beast (presuming all capitals and spellings are correct).

~EndWildShape - !aws end

A creature in wild shape has this Ability. When their token is selected, check the top-left of the screen for this button. Clicking it or entering the command reverts the selected creature to their normal form (if they have one).

Health Carry-over

If a wild-shape token has negative health when this command is run, the excess damage will carry over to the reverted token.

AWSadd - !aws add

Adds the selected token(s) to the wild shape list if they each represent a character.

AWSremove - !aws remove / !aws remove <beast name>

Removes the selected token(s) from the wild shape list if they each represent a character, or removes beasts from the list by name if all capitals and spelling are correct.

AWSlist - !aws list

Lists all creatures in the wild shape list, and allows the GM to remove creatures from that list by clicking the appropriate X button.

AWSpopulate - !aws populate

Automatically populates the wild shape list, adding every Beast type NPC sheet that has a default token.


Beast WildShape Preperation

  1. Make sure the beast has a player-uploaded default token.
  2. Make sure you're using a filled out Roll20 D&D 5e Character Sheet.

If its not working with a default SRD monster sheet & blank player-uploaded default token then something has gone wrong. Hit me up in the API thread or at the link below. If you're sure the issue isn't something you're doing, open an issue on this GitHub Repository.


Class and Level Override for NPCs and PCs

  1. Create an attribute on the NPC or PC sheet.
  2. Name the attribute "aws_override".
  3. Set the attribute value to "1".

If a PC is using the "aws_override" attribute the GM will be notified.


Automatic Wild Shape written by Layton Burchell:

About

Roll20 API for Automatically Wild Shaping using the Roll20 D&D 5th Edition OGL Sheet.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published