Tags:

QoL Immersion Roleplay

Author:

SiiMeR

Side:

Both

Created:

Aug 30th at 8:50 PM

Last modified:

Oct 3rd at 11:49 AM

Downloads:

5169

Recommended download (for Vintage Story 1.22.0-pre.1 - 1.22.7):
carried_2.1.1.zip  1-click install

Carried

Carry other players around: bridal, piggyback, firefighter, buddy carry, or hold hands. Each style has its own animations for both players and its own movement penalty.

Features

Carry styles

• Bridal carry - one arm under the knees, one under the back
  • 60% movespeed penalty
    
    

• Piggyback - on the back, arms around the shoulders
  • 45% movespeed penalty

• Firefighter carry - over the shoulder, head down
  • 50% movespeed penalty

• Buddy carry - side by side, arm over the shoulder
  
  • 35% movespeed penalty
    
    

• Hold hands - walk next to each other.
  • Needs the initiator to have their left hand free and the other party to have their right hand free
  • The initiator can sprint/crouch/sit, and the other party will follow along
  • Both parties can give input for movement direction, but only the initiator can turn by looking
  • 40% movespeed penalty
    
    

Picking someone up

• Look at a player and hold Y to open the carry wheel, then move your mouse in the desired direction and release Y
• The other player then gets a chat prompt to accept or refuse. Can be turned off by setting the RequireConsent config option
• Lifting takes 2 seconds (configurable), and movement cancels the timer
• Both your hands must be empty. Hold hands needs your left and their right hand free
• Open the wheel again while carrying to switch to another style
• You cannot attack, use items, or crouch while carrying someone. Taking something in a hand that should be empty ends the carry
• If you are under 15% max HP, you will drop whoever you are carrying. 

Putting down

• Hold Shift + Y to put them down, or pick Let go in the wheel
• The carried player can use the same key to get off
• The carry also ends if you get too far apart, if the carrier starts swimming (configurable), if either of you dies, or if the carried player hits the carrier

Being carried

• The camera view is about at the point where your head would be, but it's not rotated in any way
• Your view is limited to a cone around the direction the upper torso faces
• The visual head rotation angle has been increased to about 70 degrees (up from 45 degrees)
• While holding hands, you can walk to pull the carrier in your direction, so either player can lead. The camera turning is still only controlled by the initiator
• You cannot target the player you are attached to as the carrier

Carry editor

• The mod comes with a built-in editor for authoring the pose changes as the size ratio changes
• It has some handy tools for adjusting the position and rotation of the shapes 
• There is also a treadmill option to see it in action
• Access it with .carryeditor (requires you to be in Creative mode)

Different sizes

• Poses are saved per size ratio and interpolated between, so a small player carried by a big one still properly sits
• A larger passenger slows the carrier down more, up to MaxSizePenaltyMultiplier, meaning at default values that if the carried person is 2x bigger, they will have 2x higher penalties 
• MinWalkSpeed stops the penalty from making the carrier's movespeed 0

Adding your own styles

• Carry styles are JSON files in assets/carried/config/carrytypes/, animations in assets/carried/config/carryanimations/. Any mod can add them without code
• The wheel icon is read from textures/<code>.png in your domain, the name from the lang key type-<code>
• Styles can be built in-game with .carryeditor in creative mode
• If the server has a style your client does not, it is mentioned in the logs

Configuration

The config can be adjusted in carried.json or in-game via ConfigLib.

{
  "RequireConsent": true,                 // Whether the other player has to accept the request first
  "CarryRange": 3,                        // Max distance in blocks to pick someone up
  "CarryMaxDistance": 6,                  // The carry ends by itself past this distance
  "PutDownHoldSeconds": 2,                // Seconds to hold Shift + Y to put someone down
  "PickupSeconds": 2,                     // Seconds to lift someone or switch style (0 = instant)
  "EndCarryInWater": true,                // Stop the carry when the carrier starts swimming
  "MaxSizePenaltyMultiplier": 2,          // Cap on the extra slowdown from a larger passenger (1 = no size scaling)
  "MinWalkSpeed": 0.05,                   // The carry penalty never drags walkspeed below this (0 = no floor)
  "MinCarryHealthFraction": 0.15          // The carrier must be over this percentage of their max HP to continue carrying. Set to 0 to disable this. 
  "BaseCarryMovementPenalty": -0.6,       // Walk speed change for styles that have no penalty of their own (if you don't set it in JSON)
  "BaseHandholdMovementPenalty": -0.4,    // Walk speed change while holding hands
  "BaseBridalMovementPenalty": -0.6,      // Walk speed change for the carrier during a bridal carry
  "BasePiggybackMovementPenalty": -0.45,  // Walk speed change for the carrier during a piggyback
  "BaseFirefighterMovementPenalty": -0.5, // Walk speed change for the carrier during a firefighter carry
  "BaseBuddyMovementPenalty": -0.35       // Walk speed change for the carrier during a buddy carry
}

Commands

/carryother <style> - carry the player you are looking at, same as the wheel
/carryother accept - accept a pending carry request
/carryother refuse - refuse a pending carry request
/carryother putdown - put down whoever you are carrying
/carryother consent <true|false> - consent to being automatically picked up
.carryeditor - pose editor, client side, creative mode only

Making an entity from another mod carryable (for mod authors)

1. Add the behavior to both sides (client drives selection and the carried animation, server drives eligibility):

[
  {
    "file": "yourmod:entities/yourentity", "op": "add", "path": "/server/behaviors/-",
    "value": { "code": "carriedcarry" }, "dependsOn": [{ "modid": "yourmod" }]
  },
  {

    "file": "yourmod:entities/yourentity", "op": "add", "path": "/client/behaviors/-",
    "value": { "code": "carriedcarry" }, "dependsOn": [{ "modid": "yourmod" }]
  }
]

2. Optionally merge carry options into the entity type's attributes:

{

    "file": "yourmod:entities/yourentity", "op": "addmerge", "path": "/attributes/carried",
    "value": {
      "denyTypes": ["handhold"],
      "denyTypesWhenAttrs": { "someattribute": ["handhold"] },
      "blockCarryWhenAttrs": ["somebusyattr"],
      "skipConsentWhenAttrs": ["someattr"]
    },
    "dependsOn": [{ "modid": "yourmod" }]

}

Requirements: the entity must be an EntityAgent, and for carry poses to read correctly it should use seraph bone names - the carry animations and the size-profile bone deltas are seraph-rig specific.

Non-player passengers get their passive physics paused for the duration of the carry and their server position driven from the seat; their active animations are suspended on pickup and restored on release.

Compatibility

• PlayerModelLib: custom models and sizes work, poses adjust to the size difference
• PlayerModelNPCs: NPCs can be carried like players
• Dead: Corpses can be carried like players, but only when they are not being hung on a hook or already dragged. Only firefighter and bridal carries available
• Downed: Downed players can be carried like players. Every carry except handholding available
• ConfigLib: optional, used for the in-game config menu

Animations for this mod were made by the always amazing W4RD0