Skip to content

Advancement User Guide

github-actions[bot] edited this page Jan 31, 2024 · 2 revisions

Up to date as of 3.0.0

Class Items

1.6 has added the ability to easily define what items should be granted to an actor when it is levelled up in a given class or subclass. This initial release covers a majority of users' needs for streamlining the level up process, however it does not cover all use cases currently, and improvements will be made with subsequent releases. This guide will assist you in creating your own custom classes, as well as provide tips and tricks for navigating the current state of the implementation.

There is a new option in the System Settings to disable this feature for all players in a world by using the "Disable level-up automation" option in the 5e system settings. To avoid running advancements on an individual character, any advancements should be removed from the class, subclass, or background before it is dropped on the character sheet.

Note that once the Advancement process has been started, any manual changes to the actor or items added to the actor manually will be reverted once the Advancement workflow is completed.

Class Item Updates

The following section will discuss changes made to the Class item type.

The Details tab

  • Identifier field: this will allow you to configure the name of the class that can be used to reference it in roll formulas (useful for classes with spaces, or localizing the class to other languages). The class identifier may only contain letters, numbers, hyphens (-), and underscores (_).
  • Level field: has been removed, class levels will be managed from the actor sheet, see the second screenshot below.

Class Details

Class Level Dropdown

The Advancement tab

This is where you will configure the Advancement items for this class.

  • Add a new Advancement item with the + button, edit an existing item with the [pen] icon, or delete an existing advancement item with the [trash] icon.
    • (Note: deleting one Hit Point or Scale Value advancement item will delete all of that type for the class).
  • Configuration Disabled/Enabled - This will only display when the class is placed on an actor, it can be toggled to enable or disable making modifications to the advancement items.
  • Modify Choices - This will only display when the class is placed on an actor, and if Configuration is disabled, this allows a user to change any choices they made for that level.
  • Advancement items are sorted within each level alphabetically by type in the following order: Hit Points, Item Grant, Scale Value.

Advancement Example

Advancement Item Types

There are currently 3 types of Advancement Items that can be added to a Class item: Hit Points, Item Grant, and Scale Value. All Advancement Items have the following fields:

  • Custom Title: Choose what you would like the title of this advancement item to display on the Advancement tab.
  • Custom Icon: Choose an icon to represent this item on the Advancement tab.
  • Class Restriction:
    • All Classes - These items should be granted in any case.
    • Original Class Only - Only if this class is the initial class.
    • Multiclass Only - Only if this class is chosen as a multiclass.

Basic Advancement Configuration

Ability Score Improvement

This advancement item will prompt for the user to select ability scores to improve, or apply a fixed improvement. For more information, see Ability Score Improvement Advancement

Hit Points

This advancement item will prompt for the user to Roll for HP or use the average, using the Hit Die noted in the Details tab of the Class item.
For more information, see Hit Points Advancement

Item Grant

This advancement can grant another item on level up (e.g. Class Features, Equipment). It should not be used for Class Spellcasting as a separate Advancement type is planned for that. It can be used for Racial Spellcasting, however.
For more information, see Item Grant Advancement

Item Choice

This advancement type is designed for any feature that gives the player a choice of options to add to their character at a certain level. This covers features with a limited set of options such as Fighting Style and more open ended features such as Magical Secrets.
For more information, see Item Choice Advancement

Scale Value

This can be used to track when features get extra uses (e.g. Wild Shape or Channel Divinity), or the die value of a feature increases (e.g. Sneak Attack or Martial Arts) For more information, see Scale Value Advancement

Size

This can be used to set an actor's size through their race. For more information, see Size Advancement

Trait

This can be used to grant proficiencies in skills, weapons, armor, and tools, as well as grant languages, damage resistances, and more. For more information, see Trait Advancement

Managing Class Levels on an Actor

Adding a Class to an Actor

AUG-AddClass.mp4
  1. Drag a Class item onto your Actor's Features tab.
    • Note: You can cancel the advancement process at any time by clicking the dialog's X Close button.
  2. You will be prompted to first accept the Hit Points advancement (HP for your original class at level one is always the maximum hit die value plus your Constitution modifier). Click the Next button to advance to the next advancement item.
  3. You will then be prompted for any additional advancement items, clicking on the name of the feature will allow you to preview the item that will be added to the actor, if an advancement item is set to optional, the user will be able to select the check box to determine if that item should be added or not. Once the user is ready to advance, click Continue.
  4. On any subsequent step you will have a Restart button, this will return you to the beginning of the Advancement process.
  5. On the final advancement item you will have a Complete button, click it to apply the changes to your actor. The HP values will adjust, and the items will be added to your character at this time.

Leveling Up

AUG-LevellingUp.mp4
  1. On your Actor's Features tab, find the Level option for your class, click it to open the drop down and select the level you would like to advance to.
  2. The appropriate advancement items will be presented to you, use the steps as described above to move through the process.

Modifying a previous advancement choice

AUG-ModifyChoice.mp4
  1. If you made a mistake on a previous level up, such as selecting the wrong item or accidentally deselecting an item, navigate to the Features tab of your actor, and click the Edit icon for their Class item.
  2. In the Advancements tab, make sure the Configuration is disabled, then find the level to modify and click the Modify Choices button
  3. The system will walk you through all of the advancement items for that level to adjust any choices made for that level.

Leveling Down or Removing a Class

AUG-LevellingDown.mp4
  1. On your Actor's Features tab, find the Level option for your class, click it and select the level you would like to revert to from the drop down, or click the Trash can icon to completely remove the class or subclass.
  2. The system will display a dialog to confirm the change and provide a toggle to remove any advancement items that have been earned up to this level, leaving the box checked will ensure items granted from previous level ups will be removed from the actor.

Managing Subclasses

Presently the Subclass advancement type is not available in this release, and will be introduced in a later release. This advancement type will allow the triggering of the advancement workflow if an added item has advancement items attached to it.

The current recommended process is to manually drag and drop the subclass onto the actor after completing the Advancement process for the given level, which will prompt for the appropriate advancements for the character's level in the parent class.

AUG-AddSubclass.mp4

Updating Advancements for an owned Class item

If you are building your own custom class, or modifying an existing class record, once a class is added to an actor it is owned by that actor and is separate from the parent class item in the items sidebar or compendium. For example, if you built a class item with advancements to level 5 and added it to an actor, then later updated the class in the compendium to add advancements to level 10, dragging and dropping that class item onto the actor will not provide the new advancement items to the owned class item.

You will need to manually update the owned class item with the new advancement items, separate from the compendium class item.

In an upcoming release, a process to update advancement items from the 'master copy' class item to an owned class item will be added to the system.

Clone this wiki locally