A visual modification to player character sheets to better display the effects of the Encumbrance variant ruleset in the PHB.

• The rules for Lifting and Carrying are intentionally simple. Here is a variant if you are looking for more detailed rules for determining how a character is hindered by the weight of Equipment. When you use this variant, ignore the Strength column of the Armor table.
• If you carry weight in excess of 5 times your Strength score, you are encumbered, which means your speed drops by 10 feet.
• If you carry weight in excess of 10 times your Strength score, up to your maximum carrying Capacity, you are instead heavily encumbered, which means your speed drops by 20 feet and you have disadvantage on Ability Checks, Attack rolls, and Saving Throws that use Strength, Dexterity, or Constitution.

The effects of this module are currently purely visual, although restricting movement and applying the negative effects of encumbrance are applied with the new active effect mechanism.

For D&D5e 1.4.2 and newer the system supports a core implementation of this encumbrance rule. The module should be synchronized with the core functionality, but this module will permit more customised rules for your weight calculations/thresholds and the speed penalties are integrated with active effect.

It's always easiest to install modules from the in game add-on browser.

To install this module manually:

1. Inside the Foundry "Configuration and Setup" screen, click "Add-on Modules"
2. Click "Install Module"
3. In the "Manifest URL" field, paste the following url:

https://raw.githubusercontent.com/VanirDev/VariantEncumbrance/master/src/module.json

4. Click 'Install' and wait for installation to complete
5. Don't forget to enable the module in game using the "Manage Module" button

This module uses the libWrapper library for wrapping core methods. It is a hard dependency and it is recommended for the best experience and compatibility with other modules.

This module uses the socketLib library for wrapping core methods. It is a hard dependency and it is recommended for the best experience and compatibility with other modules.

This module uses the active-effect-manager-lib library like a dependency. It is a hard dependency and it is recommended for the best experience and compatibility with other modules.

This module uses the midi-qol. It is a optional dependency but it is recommended for the best experience and compatibility with other modules.

NOTE: If "midiqol" is deactivated or not present, the active effects will apply only the speed reduction without the variations of advantage and disadvantage typical of the rule

• Due to the million variations of the various use cases that I have to take into account the most attentive players may notice a slowdown which is logical if you think I have to redo the checks and refresh the flags every time it is inserted, updated, deleted, revised , edited an object with weight. You need someone more Expert than me to handle this, but i still think to have done a good job with the handling of the use cases.
• Limitation on some character sheet, open a issue and i'll try to make a fix.
• Is not full synchronized with DAE in favor of the standard active effects mechanism. but you can still use dae on the active effect.
• I have not found the time to fully test for the vehicle sheet so any feedback is more than welcome, seem to work anyway

• D&D5e Default Character Sheet

• Sky's Alternate 5th Edition Dungeons & Dragons Sheet Seem to work

• Tidy5e Sheet (Both light & dark themes) Seem to work

• Compact DnDBeyond-like 5e Character Sheet Active effect work, but there is no visual bar , the values of the weight are synchronized with the system core

• DNDBeyond Character Sheet for 5E Active effect work, but there is no visual bar , the values of the weight are synchronized with the system core

• Inventory + version 0.4.0
• Dynamic Active Effects
• DFreds Convenient Effects version 1.8.5
• Item Collection/Item Containers version 1.8.13
• DragonFlagon Quality of Life, Vehicle Cargo Capacity Unit Feature version 1.6.0

I highly recommend avoiding module Inventory + in favor of the module Item Collection/Item Containers

The default character weight bar has received a lick of paint, giving labels for all four weight thresholds. These thresholds are also reconfigurable in the settings, and will update the bar to display the new proportions.

Your encumbrance status is automatically used to provide a modified speed value, taking your default character speed and modifying it by -10 and -20 for encumbered and heavily encumbered, and reducing to 0 when over encumbered. (For 0.1.5, the speed value must be separated by a space from its units).

Powerful Build Feature: You count as one size larger when determining your carrying capacity and the weight you can push, drag, or lift.

Enabled by default, the module will modify your maximum carry weight according to your character's size, and whether you have the powerful build special trait. This feature can be disabled in the module settings. (Credit to Eruestani for implementing this).

In the module settings, custom multipliers are available for unequipped, equipped, and proficiently equipped items. This was mainly added for my house rules, where equipped proficient items get a small weight reduction due to experience handling them, but this lends some flexibility to the system for anyone to use.

Add new buttons on the header sheet of the actors for choose when to avoid to add the Active Effect or weight calculation. To much bad feed back on the automatization of the AE, i hope with this to help the community to find the best solution for the single individual

Symbol Button Header Sheet	Description
	If you want to have the Varian Encumbrance Active Effects and Weight calculation features on your actor make sure to have the "weight" symbol on the header sheet (this is the default)
	If you don't want to have the Varian Encumbrance Active Effects feature on your actor make sure to have the "balance" symbol on the header sheet. ATTENTION the weight calculation feature is still active
	If you don't want to have the Variant Encumbrance Active Effects and Weight calculation features on your actor make sure to have the "feather" symbol on the header sheet. The weight is not calculated anymore and remain frozen (unless the setting 'Use standard calculation weight of the dnd5e system' is set to true in that case the weight calculation rollback to the standard weight calculation of the system dnd5e)

Some preview:

NOTE: from 0.6.11 the button are colored !!!

This feature is enabled with the module setitng 'Fake the metric system calculation, but we using the imperial one'

Use this only with the system setting 'Use Metric Weight Units' checked. because that setting doesn't update the value in lbs. to kg. of the item so the calculation is 'visually wrong', with this setting set to true we use the same imperial encumbrance costants, and avoid the problem, but this is a patch not a solution, this is why there it was this module in the past https://github.com/HadaIonut/Foundry-mgl

The calculation should be correct, the metric values ​​2.5, 5, 7.5 are the official ones of the dnd5e system, the problem is that checking the metric system checkbox does not consequently update the item values ​​as we would expect 1lb = 0.45kg but remains 1lb = 1kg therefore an object that weighs 6lb will result in weighing 6kg and this gives the illusion of displacing the weight, the description clearly says so Replaces all reference to lbs with kgs and updates the encumbrance calculations to use metric weight units. where with reference we mean the label 'lbs' in 'kg' not the value .... this is done on purpose to avoid a massive update of the items, consequently it does not update the weight on the objects, you can also check with the module deactivated. However, I attach an image for clarity.

An active inventory manages items using inventory slots (storage capacity) and object bulk (carrying effort).

Inventory slots describe storage capacity—how much can a thing carry without being overwhelmed? One slot holds one small object—a potion bottle, a dagger, a loaf of bread, etc.

Anything that can hold, carry, or contain objects can make use of inventory slots—for example:

• Creatures use slots to describe how much they can carry before they're encumbered.
• Containers use slots to describe how much they can store before they're full.
• Buildings use slots to describe how much free space they have in their rooms.
• Vehicles use slots to describe how much they can transport before they can't move.

Your inventory capacity depends on your creature size and strength modifier—the bigger and stronger you are, the more inventory slots you have.

As your size increases, so too does your bulk—a larger creature takes more effort to carry. Your bulk equals the larger of either a) your minimum bulk or b) the total bulk of everything in your inventory.

Creature Inventory

Here we see three characters calculate their inventory:

• Valiant, a human cleric, is a medium-sized creature (18 slots) with +2 STR (+2 slots). He has a total of 20 inventory slots, and occupies a minimum of 20 slots when carried.
• Crackle, a kobold wizard, is a small creature (14 slots) with −1 STR (−1 slot). She has 13 inventory slots and occupies a minimum of 10 slots.
• Brakken, a goliath barbarian, is a medium-sized creature with Powerful Build (22 slots) and +3 STR (+6 slots). She has 28 inventory slots and occupies a minimum of 20 slots when carried.

Objects use bulk to describe how many inventory slots they fill—the bulkier the object, the more slots occupied.

Bulk represents the effort needed by a medium-sized creature to carry an object based on its size, weight, and shape—the more awkward or uncomfortable it is to hold an object, the higher its bulk.

Add new buttons on the header sheet of the actors for choose when to avoid to add the Active Effect or weight calculation. To much bad feed back on the automatization of the AE, i hope with this to help the community to find the best solution for the single individual

Symbol Button Header Sheet	Description
	If you want to have the Varian Encumbrance Active Effects and Weight calculation features on your actor make sure to have the "bold" symbol on the header sheet (this is the default)
	If you don't want to have the Varian Encumbrance Active Effects feature on your actor make sure to have the "balance" symbol on the header sheet. ATTENTION the weight calculation feature is still active
	If you don't want to have the Variant Encumbrance Active Effects and Weight calculation features on your actor make sure to have the "feather" symbol on the header sheet. The weight is not calculated anymore and remain frozen (unless the setting 'Use standard calculation weight of the dnd5e system' is set to true in that case the weight calculation rollback to the standard weight calculation of the system dnd5e)

Should you wish to integrate some of Variant Encumbrance's calculations into your own modules, there is now a flag which stores the actor's encumbrance tier, weight, and modified speed. Encumbrance tier is presented as 0, 1, 2, 3, as Unencumbered, Encumbered, Heavily Encumbered, Over Encumbered, respectively.

variant-encumbrance-dnd5e:
{
  burrow: 0,
  climb: 0,
  fly: 0,
  swim: 0,
  walk: 30,
  data: {
    totalWeight: 0,
    totalWeightToDisplay: 0,
    lightMax: 50,
    mediumMax: 100,
    heavyMax: 150,
    encumbranceTier: 0,
    speedDecrease: 0,
    unit: 'lbs',
    encumbrance: {
        value: 150,
        max: 100,
        pct: 200,
        encumbered: true,
    }
  },
  bulk: {
    totalWeight: 0,
    totalWeightToDisplay: 0,
    lightMax: 50,
    mediumMax: 100,
    heavyMax: 150,
    encumbranceTier: 0,
    speedDecrease: 0,
    unit: 'bulk',
    encumbrance: {
        value: 150,
        max: 100,
        pct: 200,
        encumbered: true,
    },
    inventorySlot: 60,
    minimumBulk: 2;
  },
  enabledae: true,
  enabledwe: true,
  enabledaebulk: false,
  enabledwebulk: true,
}

• burrow: the value in units for the burrow movement get from property actor.data.data.attributes.movement.burrow.
• climb: the value in units for the climb movement get from property actor.data.data.attributes.movement.climb.
• fly: the value in units for the fly movement get from property actor.data.data.attributes.movement.fly.
• swim: the value in units for the swim movement get from property actor.data.data.attributes.movement.swim.
• walk: the value in units for the walk movement get from property actor.data.data.attributes.movement.walk.
• totalWeight: the 'real' total weight synced with the core system of dnd5e.
• totalWeightToDisplay: the 'fake' total weight not synced with the core system of dnd5e, is used for manage on a display level feature from other module like "Vehicle Cargo Capacity Unit" from the module 'DF QUALITY OF LIFE'.
• lightMax: the weight value for pass from 'unencumbered' to 'encumbered' and back.
• mediumMax: the weight value for pass from 'encumbered' to 'heavily encumbered' and back.
• heavyMax: the weight value for pass from 'heavily encumbered' to 'overburdened' and back.
• encumbranceTier: the number given the current tier applied don the actor
  • 0 = Unencumbered
  • 1 = Encumbered
  • 2 = Heavily Encumbered
  • 3 = Over Encumbered (Overburdened)
• speedDecrease: the value in units of the decreased movement (this change if the metric system is active or not).
• unit: the label applied to the unit weight, just a visual effect (default is lbs. on metric system is kg.).
• encumbrance: the representation of the standard dnd5e system encumbrance data useful for integration between modules.
• inventorySlot: describe storage capacity—how much can a thing carry without being overwhelmed? One slot holds one small object—a potion bottle, a dagger, a loaf of bread, etc.
• minimumBulk: the calculated minimum bulk fir the current actor
• enabledae: if true it's mean on the actor is applied the management of the active effects of the weight from the module. NOTE: if you set true this is better to set to false 'enabledwe'
• enabledwe: if true it's mean on the actor is applied the calculation of the weight from the module.
• enabledaebulk: if true it's mean on the actor is applied the system bulk the management of the active effects of the weight from the module. NOTE: if you set true this is better to set to false 'enabledwe'
• enabledwebulk: if true it's mean on the actor is applied the system bulk and the calculation of the weight from the module.

Calculate the weight on the actor with all the filters applied.

Returns: EncumbranceData - A EncumbranceData object

Example: game.modules.get('variant-encumbrance-dnd5e').api.calculateWeightOnActorFromId('Pippo')

Calculate the weight on the actor with all the filters applied.

Returns: EncumbranceData - A EncumbranceData object

Example: game.modules.get('variant-encumbrance-dnd5e').api.calculateWeightOnTokenFromId('Pippo')

Calculate the weight on the actor with all the filters applied.

Returns: EncumbranceData - A EncumbranceData object

Example: game.modules.get('variant-encumbrance-dnd5e').api.calculateWeightOnActor(actor)

Calculate the bulk on the actor with all the filters applied.

Returns: EncumbranceData - A EncumbranceData object

Example: game.modules.get('variant-encumbrance-dnd5e').api.calculateBulkOnActorFromId('Pippo')

Calculate the bulk on the actor with all the filters applied.

Returns: EncumbranceData - A EncumbranceData object

Example: game.modules.get('variant-encumbrance-dnd5e').api.calculateBulkOnTokenFromId('Pippo')

Calculate the bulk on the actor with all the filters applied.

Returns: EncumbranceData - A EncumbranceData object

Example: game.modules.get('variant-encumbrance-dnd5e').api.calculateBulkOnActor(actor)

Convert weight to bulk

Returns: EncumbranceData - A EncumbranceData object

Example: game.modules.get('variant-encumbrance-dnd5e').api.convertLbToBulk(weight)

Here the EncumbranceData structure:

{
  totalWeight: number,
  totalWeightToDisplay: number,
  lightMax: number,
  mediumMax: number,
  heavyMax: number,
  encumbranceTier: number,
  speedDecrease: number,
  unit: string,
  encumbrance:EncumbranceDnd5e;
}

Here the EncumbranceDataDnd5e structure:

{
  value: number;
  max: number;
  pct: number;
  encumbered?: boolean; //Vehicle not have this
}

Here the EncumbranceBulkData structure extends EncumbranceData:

{
  totalWeight: number,
  totalWeightToDisplay: number,
  lightMax: number,
  mediumMax: number,
  heavyMax: number,
  encumbranceTier: number,
  speedDecrease: number,
  unit: string,
  encumbrance:EncumbranceDnd5e;
  inventorySlot: number;
  minimumBulk: number;
}

npm install

will build the code and copy all necessary assets into the dist folder and make a symlink to install the result into your foundry data; create a foundryconfig.json file with your Foundry Data path.

{
  "dataPath": "~/.local/share/FoundryVTT/"
}

build will build and set up a symlink between dist and your dataPath.

npm run-script build

You don't need to build the foundryconfig.json file you can just copy the content of the dist folder on the module folder under modules of Foundry

build:watch will build and watch for changes, rebuilding automatically.

npm run-script build:watch

clean will remove all contents in the dist folder (but keeps the link from build:install).

npm run-script clean

lint launch the eslint process based on the configuration here

npm run-script lint

lintfix launch the eslint process with the fix argument

npm run-script lintfix

prettier-format launch the prettier plugin based on the configuration here

npm run-script prettier-format

package generates a zip file containing the contents of the dist folder generated previously with the build command. Useful for those who want to manually load the module or want to create their own release

npm run-script package

Any issues, bugs, or feature requests are always welcome to be reported directly to the Issue Tracker, or using the Bug Reporter Module.

This package is under an MIT license and the Foundry Virtual Tabletop Limited License Agreement for module development.

Bootstrapped with League of Extraordinary FoundryVTT Developers foundry-vtt-types.

Mad props to the 'League of Extraordinary FoundryVTT Developers' community which helped me figure out a lot.