Back to mods
PhysicsLib - Solid boats and entities project artwork

Vintage Story Mod DB · Vintage Story mod

PhysicsLib - Solid boats and entities

After many moons of coding to determine how on earth player motion is controlled by vintage story, i present to you PhysicsLib - Solid Entities. On its own, solid entities only makes the vanilla sailboat walkable, but it opens the door for any modder to patch

Choose a version Pick your version below, then grab the matching file.

Quick answer

Which PhysicsLib - Solid boats and entities release should I use?

Updated 3 months ago
Latest stable file 1.3.0
Game version 1.22.1, 1.22.2, 1.22.3
Loader Built-in Vintage Story mod system

PhysicsLib - Solid boats and entities 1.3.0 targets 1.22.1, 1.22.2, 1.22.3. It must be installed on the client. Installation on the dedicated server is optional. No extra mods listed for this file.

Where it goes

Is PhysicsLib - Solid boats and entities required on the client, server, or both?

It must be installed on the client. Installation on the dedicated server is optional.

Client Required
Dedicated server Optional
Loader for this release Built-in Vintage Story mod system
Required install it here Optional supported, not mandatory Not supported do not install here Source doesn’t say do not assume

This release supports both sides, but the source does not require it on the server.

What else does PhysicsLib - Solid boats and entities 1.3.0 need?

1.3.0. Change the file and its required mods may change too.

No extra mods listed for this file

This file does not list any required mods. Do not add a library just because a different file uses it.

VS AIRSHIP MOD Optional for PhysicsLib - Solid boats and entities 1.3.0
optional
Matching file found Matched file: 1.1.4

We only count dependency files that match this setup. A file for another loader does not fill the gap.

Before you install it

Add PhysicsLib - Solid boats and entities without breaking your instance.

Built for PhysicsLib - Solid boats and entities 1.3.0. Pick another file and the loader, install side or required mods may change.

  1. 01

    Stick to this file

    Use 1.3.0. It targets 1.22.1, 1.22.2, 1.22.3; another release may have different loader, side or dependency requirements.

  2. 02

    Bring the mods it needs

    This file does not list any required mods. Do not add a library just because a different file uses it.

  3. 03

    Put it on the correct side

    It must be installed on the client. Installation on the dedicated server is optional.

  4. 04

    Pick the file you checked

    Use the “Get this file” button beside 1.3.0. It opens that exact file at the source.

About this project

What does PhysicsLib - Solid boats and entities add?

After many moons of coding to determine how on earth player motion is controlled by vintage story, i present to you PhysicsLib - Solid Entities.

 

On its own, solid entities only makes the vanilla sailboat walkable, but it opens the door for any modder to patch existing entities or implement their own with solid collisions!

 

Mods Currently leveraging PhysicsLib:

 

Spoiler!

VS Airships

Shipwrights

 

 

How does it work?

 

Physics lib is simple, it implements 1 entity behaviour which can be patched onto existing entities, or leveraged directly within mods - behaviour code: "dynamic-physics".

With this one entity behaviour attached, every cube in the shape file of the model will be used to build up a dynamic collision box for the shape of the entity, and then caches it to be reused for every instance of that model.

 

In order to prevent EVERY cube being used, wildcard selection can be used against the cubes of the model.


(For Modders/Asset creators) How to set it up for your own entities, or patch existing ones:

 

  1. Remove the ellipsoidalrepulseagents from the entity(if present, otherwise your fancy new solid entities will be pushed away from your own hitbox)
  2. Add the physicslib behaviour with code "dynamic-physics" to both the client and server behaviours of the entity.
  3. Optionally, supply a "selectors": [] object with a list of selectors for the list of cubes in the model youd like included in collision.

 

Example Patch for the vanilla sailboat, the first 2 sections remove ellipsoidrepulseagents behaviour, the next 2 add the behaviour to client and server:

 
Spoiler!
[
  {
    "file": "game:entities/nonliving/boat-sailed",
    "op": "remove",
    "path": "/server/behaviors/0"
  },
  {
    "file": "game:entities/nonliving/boat-sailed",
    "op": "remove",
    "path": "/client/behaviors/0"
  },
  {
    "file": "game:entities/nonliving/boat-sailed",
    "op": "addmerge",
    "path": "/server/behaviors",
    "value": [
      {
        "code": "dynamic-physics",
        "selectors": [
          "ORIGIN/ORIGIN-Section1/*",
          "ORIGIN/ORIGIN-Section2/*",
          "ORIGIN/ORIGIN-Prow/*",
          "ORIGIN/ORIGIN-Prow2/GunwhaleS4/*",
          "ORIGIN/ORIGIN-Prow2/GunwhaleN4/*",
          "ORIGIN/ORIGIN-Prow2/ProwFloorS6/*",
          "ORIGIN/ORIGIN-Prow2/ProwFloorN5/*"
        ]
      }
    ]
  },
  {
    "file": "game:entities/nonliving/boat-sailed",
    "op": "addmerge",
    "path": "/client/behaviors",
    "value": [
      {
        "code": "dynamic-physics",
        "selectors": [
          "ORIGIN/ORIGIN-Section1/*",
          "ORIGIN/ORIGIN-Section2/*",
          "ORIGIN/ORIGIN-Prow/*",
          "ORIGIN/ORIGIN-Prow2/GunwhaleS4/*",
          "ORIGIN/ORIGIN-Prow2/GunwhaleN4/*",
          "ORIGIN/ORIGIN-Prow2/ProwFloorS6/*",
          "ORIGIN/ORIGIN-Prow2/ProwFloorN5/*"
        ]
      }
    ]
  }
]

Project description from Vintage Story Mod DB.

Pick your setup

PhysicsLib - Solid boats and entities releases for each Vintage Story version.

Choose the version and loader you play, then open the matching release.

3 available setups

Check the dependencies, then try the file in a copied instance before changing a world you care about.

Recent files

PhysicsLib - Solid boats and entities versions and loaders

4 of 4 releases match

Looking for an older file? The official Vintage Story Mod DB project page is in Resources.