Carry On

Fork of mod made by copygirl - CarryCapacity

Allows picking up and carrying blocks, especially containers along with their contents, in your hands and on your back.

Please support my caffeine consumption

Carry On 2.0 - Early testing pre-release

Use at your own risk.

CarryOn 2.0 requires CarryOnLib to run.

CarryOn v2.0.0-pre.5

Carried block entity

• When a carried block is dropped and no suitable location is found to place it then a dropped block entity is spawned.
  • For the initial version of this feature the entity will appear as a small crate with random rotation.
• Owner has a grace period where only they can pick it up, after that anyone can interact to grab it.
• By default the entity will despawn after 30 game days
• Refer to the CarriedBlockEntity section in CarryOnConfig.json

Pickup from claims

• Players will no longer to be able to pickup dropped blocks from traders or other claims they don't own.
  • This was a feature of the Dropped Block Tracker which is being phased out.
  • Any block dropped on a claim, for which the player does not have permission, will drop as an entity.
• Pickup will perform client side claim check and block optimistic pickup attempts

Hunger modifier support

• Carrying blocks now effects hunger rates
  • Fully configurable, currently only enabled for back slot - see CarryHungerRate section CarryOnConfig.json

       Example:

"CarryHungerRate": {
  "HandsEnabled": false,
  "BackEnabled": true,
  "MinSaturationThreshold": 150.0,
  "ModifierOverrides": {
    "ByBlockCode": [
      {
        "Key": "game:crate",
        "Hands": 0.3,
        "Back": 0.4
      },
      {
        "Key": "game:log*",
        "Back": 0.5
      }
    ],
    "ByBlockClass": [
      {
        "Key": "BlockChest",
        "Back": 0.4
      }
    ],
    "SlotDefaults": {
      "Hands": 0.2,
      "Back": 0.3
    }
  }
}

Walk Speed modifier

The config format changed from earlier releases so it can be edited with AutoConfigLib.

"CarryWalkSpeed": {
  "HandsEnabled": true,
  "BackEnabled": true,
  "HandsAllowSprint": false,
  "BackAllowSprint": true,
  "ModifierOverrides": {
    "ByBlockCode": [
      {
        "Key": "game:crate",
        "Hands": -0.4,
        "Back": -0.3
      },
      {
        "Key": "game:log*",
        "Hands": -0.5,
        "Back": -0.25
      },
      {
        "Key": "game:lootvessel|sea",
        "Hands": -0.6
      }
    ],
    "ByBlockClass": [
      {
        "Key": "BlockChest",
        "Hands": -0.35,
        "Back": -0.2
      },
      {
        "Key": "BlockBarrel",
        "Hands": -0.3
      }
    ],
    "SlotDefaults": {
      "Hands": -0.25,
      "Back": -0.15
    }
  }
}

Damage drop behavior

• Players will no longer drop carried blocks from light fall damage or hunger pangs.
  • The amount of damage must exceed a configured threshhold before block is dropped.
  • Back slot is also affected - requires much heavier damage from a wolf or bear before dropped.
  • Configurable via DropCarriedOnDamage section in CarryOnConfig.json

Runtime configuration changes

• Add compatability for AutoConfigLib and auto detection of config file changes
  
  • Many of the config settings work at runtime
  • Add command to reload the config (use when Config Watcher is disabled or not working for OS)
    /carryon-reload

Mod compatibility

• Add compatibility for Upgradeable Storage
• Added missing "side": "server" property to carryable patches

CarryOn v2.0.0-pre.4 - Cluster Carry

• Allows players to pickup blocks along with any signs that are attached to them.
  • Can be enabled in the CarryOnConfig on the server: "CarryAttachedWallSigns": true
  • Feature is disabled by default

• Players can control whether they see and/or pickup with attached signs using chat commands:
  • .carryon attachedRender [true|false]
  • .carryon attachedPickup [true|false]

• BackpackSelectionMode added to CarryOnConfig 
  • This changes how CarryOn determines which backpack carry profile to use.
  • Valid values:
    • FirstFound
    • LastFound (default behaviour)
    • FirstOnly (Player Model Lib compatibility)

CarryOn v2.0.0-pre.3 allows walk speed overrides in the CarryOnConfig.json file.

e.g.: Add carry penalty for various reed chests when carried on back and crates in hands:
Note that the format has changed in pre.5+

    "WalkSpeedOverrides": {
      "ByBlockCode": {
        "game:stationarybasket*": { "Back": -0.1 },
        "lc:lblstationarybasket*": { "Back": -0.1 },
        "lcupdated:lblstationarybasket*": { "Back": -0.1 }

        "game:chest*|owl*": { "Back": -0.08 },
        "game:chest*|golden*": { "Back": -0.10 },
        "game:chest*": { "Back": -0.15 }
      },
      "ByBlockClass": {
        "BlockCrate": { "Hands": -0.8 }
      },
      "SlotDefaults": {
        "Hands": -0.25,
        "Back": -0.15
      }
    }

Note:

• Adding a positive value will speed up the player.
• Anything after the pipe '|' in the blockCode string is for matching sub block types/variants.

Pre-Release

These may not be ready for general gameplay.

----

Usage

To pick up a block with your hands, sneak and hold right-click. Both hands must be empty.
A circular progress bar will be visible around your cursor as you wait.
You can only pick up certain supported blocks, such as chests, barrels, vessels (including broken ones), anvils, ...

To put a block onto your back, sneak and hold right-click without aiming at a block (or hold Ctrl when aiming at a block). 
A smaller selection of blocks can be put on your back. Notably, baskets can be worn on your back without any downsides.

To put a block down, or from your back into your hands, just sneak and hold right-click again.

You can still interact with most doors and storage with your hands full but with a short delay (hold button to interact).

CarryOn interractions can be disabled in the client  by using to Toggle hotkey combination [ALT]+K. This is useful where CarryOn interactions conflict with another mod.

If you are unable to drop a carried block then use the Quickdrop hotkey [CTRL]+[ALT]+K (This is a workaround until the issue can be resolved)

Keybinds

The keybinds for CarryOn only appear after a world has been loaded.

The default keybinds are mapped as above with Shift carry key also being the Sneak key.

It is recommended, if you swap the Run and Sneak keys, that you do the same for the carry and swap keys.

Reload your world after changes to the keybinds to ensure they take effect (Known CarryOn bug)

New Keybind added to v1.9.4:
Toggle Double Tap Dismount: CTRL+K

Additional Information

Typically, when carrying containers, you are slowed down by some amount.
You also cannot sprint when carrying a block in your hands.

When taking any damage, you drop what you're holding in your hands.
When you die, what you're carrying on your back will drop at your death location.
If the death occurs on a land claim on which the player does not have permission and no suitable location can be found to place the block, the items will drop. Containers will spill their contents, loot vessels will smash dropping the loot and some items could break entirely (e.g. clutter has a chance of breaking)

Recommended Mods

A selection of mods regularly tested with CarryOn - in no particular order.

• Japanese translation of Mods (including CarryOn)
• Extra Chests
• Better Crates
• Primitive Survival
• Vanilla Variants
• Bricklayers
• Sortable Storage
• Cartwright's Caravan

Having issues?

Feel free to contact me on Discord: nerdscurvy

Discord link: Vintage Story > mods > Carry On (Join the Official Vintage Story Discord server)

To help with resolving issues - send me your logs:

• client-main.txt
• client-debug.txt
• server-main.txt
• server-debug.txt

More logging information can be captured by enabling the following in the CarryOn ModConfig:

"LoggingEnabled": true

CarryOn Chat Commands

ModConfig

All carryables can be enabled/disabled via the CarryOnConfig.json file in ModConfig:

{
  "ConfigVersion": 2,
  "Carryables": {
    "Anvil": true,
    "Barrel": true,
    "Bookshelf": false,
    "BunchOCandles": false,
    "Chandelier": false,
    "ChestLabeled": true,
    "ChestTrunk": false,
    "Chest": true,
    "Clutter": false,
    "Crate": true,
    "DisplayCase": false,
    "Flowerpot": false,
    "Forge": false,
    "Henbox": false,
    "LogWithResin": false,
    "LootVessel": true,
    "MoldRack": false,
    "Molds": false,
    "Oven": false,
    "Planter": true,
    "Quern": true,
    "ReedBasket": true,
    "Resonator": true,
    "Shelf": false,
    "Sign": false,
    "StorageVessel": true,
    "ToolRack": false,
    "TorchHolder": false
  },
  "Interactables": {
    "Door": true,
    "Barrel": true,
    "Storage": true
  },
  "CarryOptions": {
    "AllowSprintWhileCarrying": false,
    "IgnoreCarrySpeedPenalty": false,
    "RemoveInteractDelayWhileCarrying": false,
    "InteractSpeedMultiplier": 1.0,
    "BackSlotEnabled": true,
    "AllowChestTrunksOnBack": false,
    "AllowLargeChestsOnBack": false,
    "AllowCratesOnBack": false
  },
  "CarryablesFilters": {
    "AutoMapSimilar": true,
    "AutoMatchIgnoreMods": [
      "mcrate"
    ],
    "AllowedShapeOnlyMatches": [
      "block/clay/lootvessel",
      "block/wood/chest/normal",
      "block/wood/trunk/normal",
      "block/reed/basket-normal"
    ],
    "RemoveBaseCarryableBehaviour": [
      "woodchests:wtrunk"
    ],
    "RemoveCarryableBehaviour": [
      "game:banner"
    ]
  },
  "DroppedBlockOptions": {
    "NonGroundBlockClasses": [
      "BlockWater",
      "BlockLava"
    ]
  },
  "DebuggingOptions": {
    "LoggingEnabled": false,
    "DisableHarmonyPatch": false
  }
}

{
  "AnvilEnabled": true,
  "BarrelEnabled": true,
  "BookshelfEnabled": false,
  "BunchOCandlesEnabled": false,
  "ChandelierEnabled": false,
  "ChestLabeledEnabled": true,
  "ChestTrunkEnabled": false,
  "ChestEnabled": true,
  "ClutterEnabled": false,  (Most of the clutter found in ruins)
  "CrateLegacyEnabled": true,
  "CrateEnabled": true,
  "DisplayCaseEnabled": false,
  "FlowerpotEnabled": false,
  "ForgeEnabled": false,
  "HenboxEnabled": false, 
  "LogWithResinEnabled": false,
  "LootVesselEnabled": true,
  "MoldRackEnabled": false,
  "MoldsEnabled": false,
  "OvenEnabled": false,
  "PlanterEnabled": true,
  "QuernEnabled": true,
  "ShelfEnabled": false,
  "SignEnabled": false,
  "ReedBasketEnabled": true, (Reed Chest)
  "StorageVesselEnabled": true,
  "ToolRackEnabled": false,
  "TorchHolderEnabled": false,
  "BackSlotEnabled": true, (Used to disable items carried on back)
  "AllowChestTrunksOnBack": false,
  "AllowLargeChestsOnBack": false, (e.g. ExtraChests)
  "AllowCratesOnBack": false,
  "NonGroundBlockClasses": [ 
    "BlockWater",
    "BlockLava"
  ],
  "AutoMatchIgnoreMods": [
    "mcrate"
  ],
  "AllowedShapeOnlyMatches": [
    "block/clay/lootvessel",
    "block/wood/chest/normal",
    "block/wood/trunk/normal",
    "block/reed/basket-normal"
  ],
  "InteractDoorEnabled": true, (Hold interact button to open doors when carrying block in hands)
  "InteractStorageEnabled": true, (Hold interact button to open storage container when carrying block in hands)
  "AllowSprintWhileCarrying": false, (When true, players can still sprint while carrying chests, etc.)

  "IgnoreCarrySpeedPenalty": false, (When true, players will have normal movement speed when carrying block in hands and on back)
  "RemoveInteractDelayWhileCarrying": false, (When true, players can open doors and chests instantly while carrying a block in their hands)
  "InteractSpeedMultiplier": 1.0, (Multiplier to change the speed of the progress circle when interacting with carryable blocks)
  "LoggingEnabled": false (Output extra logging information)
}

{
  "HoldControlForBackSwapFocus": true
}

Known Issues

• Multi-block carryables are not fully supported. They have a habit of deleting other blocks if dropped. The Trunks should be okay.
• Some players have encountered an issue where they are unable to drop crate, clutter or other carried block. Current workaround is to use the Quickdrop key [Ctrl]+[Alt]+K.
  • Try going to the Key Controls section then uncheck 'Mouse click modifiers locked to Sneak/Sprint keys' and check it again. This can sometimes free-up strange keybind behavior.