Variant Encumbrance

If you want to buy me a coffee 

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.

Installation

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/p4535992/foundryvtt-variant-encumbrance-dnd5e/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

libWrapper

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.

socketLib

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.

midi-qol

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

Compatibility

Character Sheets Compatibility

• 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

Other Modules Compatibility

• Inventory +
• Dynamic Active Effects
• DFreds Convenient Effects
• Item Collection/Item Containers
• DragonFlagon Quality of Life, Vehicle Cargo Capacity Unit Feature
• Backpack Manager

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

Hooks

From version 0.14.X you can add your own code for customize the item weight.

I will check on my side these keys on the options object:

• veweight: The new item weight
• bulk: The new item bulk weight
• TODO other stuff ???

NOTE: Is not a async function

NOTE: typeOfWeight indicate the type of weight used for standard weight the value is veweight for bulk is bulk

Hooks.on("variant-encumbrance-dnd5e.customizeItemWeight", (actor, item, itemWeight, typeOfWeight, options) => {
  if(typeOfWeight === "veweight") {
    let newWeight = // DO SOMETHING
    setProperty(options, `veweight`, newWeight); // NOTE : 'weight' value must be a number or it will be ignored
  }
  if(typeOfWeight === "bulk") {
    let newBulk = // DO SOMETHING
    setProperty(options, `bulk`, newBulk); // NOTE : 'bulk' value must be a number or it will be ignored
  }
});

Features

Redesigned weight bar

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.

Effect-based Speed Reduction with Active Effects

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).

Character Size & Powerful Build (Optional)

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).

Item Weight Multipliers (Optional)

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.

Buttons header sheet for enable/disable the features of Variant Encumbrance (Weight Calculation and Active Effects) actor by actor

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 !!!

Fake the metric system calculation, but we using the imperial one

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.

Integration with System Bulk based on the rules from Giffyglyph

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

Inventory slots

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

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.

More details about the calculation can be found here

Bulk

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.

Automatic suggested bulk

By default when the Bulk feature is enabled a little label "Suggested Bulk" show up on the item sheet preview for give a suggestion for the convertion lb/g to bulk based on the below giffyglyph table:

Buttons header sheet for enable/disable the features of Bulk (Weight Bulk Calculation and Active Effects Bulk) actor by actor

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)

Homebrew rules from the community !!!

Feature: Do Not increase weight by quantity for no ammunition item: This is a homebrew rule, for non-ammunition items don't increase weight by quantity (so 5 potions = 1 item weight for example

Feature: Equipped Armor Weight Multiplier: This is a homebrew rule, for equipped Armor types, if the weight is set to -1 is not applied, this will override the setting from 'Equipped Item Weight Multiplier'. NOTE: The specific armor calculation setting 'Feature: Equipped Armor Weight Multiplier for 'XXX Armor' will be override this setting ONLY IF THE VALUE IS EQUAL TO 0.

Feature: Equipped Armor Weight Multiplier for 'Clothing Armor': This is a homebrew rule, and is mostly an upgrade of the existing feature 'Equipped Item Weight Multiplier' for equipped armor types 'clothing', a specific multiplier is applied to the weight value. NOTE: This setting is working only with the feature from 'Feature: Equipped Armor Weight Multiplier' IS EQUAL TO 0, the value by default the value is 0.

Feature: Equipped Armor Weight Multiplier for 'Light Armor': This is a homebrew rule, and is mostly an upgrade of the existing feature 'Equipped Item Weight Multiplier' for equipped armor types 'light', a specific multiplier is applied to the weight value. NOTE: This setting is working only with the feature from 'Feature: Equipped Armor Weight Multiplier' IS EQUAL TO 0, the value by default the value is 0.

Feature: Equipped Armor Weight Multiplier for 'Medium Armor': This is a homebrew rule, and is mostly an upgrade of the existing feature 'Equipped Item Weight Multiplier' for equipped armor types 'medium', a specific multiplier is applied to the weight value. NOTE: This setting is working only with the feature from 'Feature: Equipped Armor Weight Multiplier' IS EQUAL TO 0, the value by default the value is 0.

Feature: Equipped Armor Weight Multiplier for 'Heavy Armor': This is a homebrew rule, and is mostly an upgrade of the existing feature 'Equipped Item Weight Multiplier' for equipped armor types 'heavy', a specific multiplier is applied to the weight value. NOTE: This setting is working only with the feature from 'Feature: Equipped Armor Weight Multiplier' IS EQUAL TO 0, the value by default the value is 0.

Feature: Equipped Armor Weight Multiplier for 'Natural Armor': This is a homebrew rule, and is mostly an upgrade of the existing feature 'Equipped Item Weight Multiplier' for equipped armor types 'natural', a specific multiplier is applied to the weight value. NOTE: This setting is working only with the feature from 'Feature: Equipped Armor Weight Multiplier' IS EQUAL TO 0, the value by default the value is 0.

Feature: Equipped Container/Backpack Weight Multiplier: This is a homebrew rule, for equipped container/backpack types, if the weight is set to -1 is not applied, this will override the setting from 'Equipped Item Weight Multiplier'.

Feature: Use STR flat value instead STR MOD on Bulk: This is a homebrew rule, ONLY FOR BULK calculation. Currently there is no way to adjust the maximum bulk for a creature, which is tied to size and STR MOD, now you can use the flat value of force to handle it.

Variant Encumbrance Flag

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.

FLAGS ON ACTOR DOCUMENT

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,
    },
    mapItemEncumbrance: { [index: string]: number }
  },
  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,
    },
    mapItemEncumbrance: { [index: string]: number },
    inventorySlot: 60,
    minimumBulk: 2   },
  enabledae: true,
  enabledwe: true,
  enabledaebulk: false,
  enabledwebulk: true }

FLAGS ON ITEM DOCUMENT

variant-encumbrance-dnd5e:
{
  bulk: 0
}

• burrow: the value in units for the burrow movement get from property actor.system.attributes.movement.burrow.
• climb: the value in units for the climb movement get from property actor.system.attributes.movement.climb.
• fly: the value in units for the fly movement get from property actor.system.attributes.movement.fly.
• swim: the value in units for the swim movement get from property actor.system.attributes.movement.swim.
• walk: the value in units for the walk movement get from property actor.system.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.
• mapItemEncumbrance: the inner map of the 'modified' item weight value from this module

Settings

API

game.modules.get('variant-encumbrance-dnd5e').api.calculateWeightOnActorFromId(actorIdOrName:string, ignoreCurrency:boolean) ⇒ EncumbranceData

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')

game.modules.get('variant-encumbrance-dnd5e').api.calculateWeightOnTokenFromId(tokenIdOrName:string, ignoreCurrency:boolean) ⇒ EncumbranceData

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')

game.modules.get('variant-encumbrance-dnd5e').api.calculateWeightOnActor(actor:Actor, ignoreCurrency:boolean):EncumbranceData ⇒ EncumbranceData

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)

game.modules.get('variant-encumbrance-dnd5e').api.calculateBulkOnActorFromId(actorIdOrName:string, ignoreCurrency:boolean) ⇒ EncumbranceData

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')

game.modules.get('variant-encumbrance-dnd5e').api.calculateBulkOnTokenFromId(tokenIdOrName:string, ignoreCurrency:boolean) ⇒ EncumbranceData

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')

game.modules.get('variant-encumbrance-dnd5e').api.calculateBulkOnActor(actor:Actor, ignoreCurrency:boolean):EncumbranceData ⇒ EncumbranceData

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)

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

Convert weight to bulk

Returns: EncumbranceData - A EncumbranceData object

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

game.modules.get('variant-encumbrance-dnd5e').api.calculateWeightOnActorWithItems(actor: Actor, items:Item[]): EncumbranceData | undefined

game.modules.get('variant-encumbrance-dnd5e').api.calculateBulkOnActorWithItems(actor: Actor, items:Item[]): EncumbranceBulkData | undefined

game.modules.get('variant-encumbrance-dnd5e').api.calculateWeightOnActorWithItemsNoInventoryPlus(actor: Actor, items:Item[]): EncumbranceData | undefined

game.modules.get('variant-encumbrance-dnd5e').api.calculateBulkOnActorWithItemsNoInventoryPlus(actor: Actor, items:Item[]): EncumbranceBulkData | undefined

Models

EncumbranceData

Here the EncumbranceData structure:

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

EncumbranceDnd5e

Here the EncumbranceDataDnd5e structure:

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

EncumbranceBulkData

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;
}