Skip to content

Commit

Permalink
Document summoning features on wiki (#3288)
Browse files Browse the repository at this point in the history
Co-authored-by: Kim Mantas <[email protected]>
  • Loading branch information
arbron and Fyorl authored Mar 21, 2024
1 parent 1aba956 commit 6b95412
Show file tree
Hide file tree
Showing 8 changed files with 58 additions and 0 deletions.
1 change: 1 addition & 0 deletions wiki/Home.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,5 @@
- [Hooks](Hooks.md)
- [Roll Formulas](Roll-Formulas.md)
- [Modifying Your Game with World Scripts](Modifying-Your-Game-with-Scripts.md)
- [Summoning](Summoning.md)
- [Contributing to the Wiki](Contributing-to-the-Wiki.md)
57 changes: 57 additions & 0 deletions wiki/Summoning.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
![Up to date as of 3.1.0](https://img.shields.io/static/v1?label=dnd5e&message=3.1.0&color=informational)

The D&D system includes a system for automatically bringing summoned creatures into your world. This allows you to reference a list of creatures to be summoned from a feature or spell, modify the actors before they are brought into the world, and place them where you wish in the scene.

![Summoning Summary](https://raw.githubusercontent.com/foundryvtt/dnd5e/publish-wiki/wiki/images/summoning/summoning-summary.jpg)

## Permissions

While GMs can always take advantage of summoning, this feature requires certain permissions to be set in order for it to be used by players. First the system setting "Allow Summoning" must be enabled:

![Summoning Permission](https://raw.githubusercontent.com/foundryvtt/dnd5e/publish-wiki/wiki/images/summoning/summoning-permission.jpg)

Then a few core Foundry permissions may need to be changed depending on how users will be using the feature.

- *Create New Tokens* (**required**): Players must always have permission to create new tokens for summoning to work.
- *Create New Actors*: Permission to create new actors must be set if summoning spells are configured to pull actors from compendiums. In order to use summoning without this then the GM can import actors and adjust the spells to pull from world actors rather than compendium actors. The player doing the summoning must have ownership permission on the world actor they are summoning.
- *Use File Browser*: If the token being summoned uses wildcard artwork, then players must have access to the file browser so the system can correctly set the artwork.

## Configuring Summoning

To set up a feature or spell to perform summoning, it first must have the "Action Type" of "Summon". This is configured on the details tab of the item beneath the header "Spell Effects" or "Feature Attack", depending on item type. Once that is selected a new summoning line will appear below. The "Configure Summons" button will allow for further configuration and the "Summon Prompt" checkbox will allow players to bypass the activation prompt when using the feature.

![Item Details Tab](https://raw.githubusercontent.com/foundryvtt/dnd5e/publish-wiki/wiki/images/summoning/summoning-item-details.jpg)

Clicking the "Configure Summons" button will open the summoning configuration screen. This screen contains all of the controls needed to configure what is summoned and how it is modified when summoned.

![Summoning Configuration](https://raw.githubusercontent.com/foundryvtt/dnd5e/publish-wiki/wiki/images/summoning/summoning-configuration.jpg)

### Summoning Profiles

The top section that reads "Summoning Profiles" is where the actors that will be summoned are set up. It is easy to add actors here by dragging and dropping them from the world or a compendium into the app. By default the name displayed to users will match the actor name, but that can be changed by entering a custom label in the box to the right of the link. Any extra entries can be deleted using the delete button.

In the example above, the spell "Summon Beast" from *Tasha's Cauldron of Everything*, there are three profiles created to match with the three variants of Bestial Spirit that can be created: Air, Land, and Water. Custom labels have been added to make the usage window more legible to players.

### Creature Changes

The next section lists changes that will be made to the creature being summoned. The "Match Proficiency" checkbox will cause the summoned creature's proficiency to match that of the actor doing the summoning. "Bonus Armor Class" and "Bonus Hit Points" are bonus formulas added on top of their respective values. Any `@` references in these formulas will be resolved at summoning time relative to the summoning item, so a value such as `@item.level` can be used to reference the level of the spell performing the summoning.

In the example above the match proficiency box is checked because the summoned spirits have the same proficiency as their summoner. In the AC bonus field it has `@item.level`, which increases the summoned creature's AC by the level at which the spell is cast. In the HP bonus field it has `5 * (@item.level - 2)`, which adds `5` to the creature's HP for every level the spell is cast above its base level (in this case `2`).

### Item Changes

The final section details changes that will be made to the various items on the summoned actor. "Match Attacks" ensures that the To Hit value for any attacks made by the creature match that of the summoner, and "Match Saves" does the same thing for saving throw DCs imposed by the creature's abilities. The following fields include formulas for bonuses added to all of the creature's damage from attacks, abilities that provoke saves, and healing.

In the example above both of the match attacks and saves checkboxes are checked because those values should match the summoner. In the attack damage bonus field it has the formula `@item.level` because there is a bonus to the attack damage matching the level at which the spell was cast. The save & healing bonus fields are left blank because the summoned creature doesn't have either of those.

## Performing Summoning

Once configuration is complete, summoning is very easy. Simply activate the feature or spell as you would normally and the summoning options will appear in the usage prompt.

![Summoning Prompt](https://raw.githubusercontent.com/foundryvtt/dnd5e/publish-wiki/wiki/images/summoning/summoning-prompt.jpg)

The "Place Summons" checkbox controls whether a summoned creature will be placed automatically and if there is more than one summoning profile the dropdown will allow player to select what type to summon. After this screen the player's sheet will be minimized and they will be able to place the summon in the current scene.

![Summoning Chat Message](https://raw.githubusercontent.com/foundryvtt/dnd5e/publish-wiki/wiki/images/summoning/summoning-chat-message.jpg)

If the summoned creature needs to be placed again, or the initial prompt was skipped, a "Summon" button will appear in the chat card.
Binary file added wiki/images/summoning/summoning-chat-message.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added wiki/images/summoning/summoning-item-details.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added wiki/images/summoning/summoning-permission.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added wiki/images/summoning/summoning-prompt.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added wiki/images/summoning/summoning-summary.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6b95412

Please sign in to comment.