misyltoad / VPhysics-Jolt

Volt (VPhysics Jolt) is a replacement physics module for the Source Engine.
MIT License
1.26k stars 71 forks source link

VPhysics Jolt Logo

What is Volt? ⚑

Volt (VPhysics Jolt) is a replacement for Source's VPhysics which uses IVP/Havok using Jolt Physics
Created by Joshua Ashton (🐸✨) @phys_ballsocket and Josh Dowell (Slartibarty) @Slartbarty.

Volt is designed to be incredibly high performance, supporting thousands of objects at once without bringing tick/framerate down to a crawl.

In our testing, the performance overhead from having thousands of objects moving at once, now comes from the client code needing to update/render, as going out of the PVS of these objects will still cause them to be simulated, but will no longer be rendered.

Features

Volt is mostly feature complete, but is missing some things such as support for raycast vehicles, breakable constraints, and perhaps other things we've missed!

It is our goal to implement any missing features at some point.

Below is a feature table of Volt vs VPhysics and the Bullet VPhysics project. If we missed anything we don't support or we do, feel free to add to it. It is not meant to be a bash on anyone elses work however, the Bullet VPhysics project was a great inspiration to us!

Feature VPhysics Volt (VPhysics Jolt) Bullet VPhysics
Constraints (except Pulleys) βœ”οΈ βœ”οΈ βœ”οΈ
Pulleys βœ”οΈ βœ”οΈ ❌
Breakable constraints βœ”οΈ ❌ ❌
Motors (Motion Controllers) βœ”οΈ βœ”οΈ βœ”οΈ
Motors (Constraint) βœ”οΈ βœ”οΈ ❌
Ragdolls βœ”οΈ βœ”οΈ βœ”οΈ
Triggers βœ”οΈ βœ”οΈ ❌
Object touch callbacks βœ”οΈ βœ”οΈ ❌
Prop damage/breaking βœ”οΈ βœ”οΈ ❌
Fluid events βœ”οΈ βœ”οΈ ❌
Prop splashing effects βœ”οΈ βœ”οΈ ❌
Wheeled Vehicles βœ”οΈ βœ”οΈ βœ”οΈ
Raycast Vehicles (ie. Airboat) βœ”οΈ ❌ 〰️ (janky)
NPCs/Doors (Shadow Controllers) βœ”οΈ βœ”οΈ βœ”οΈ
Save/Restore Support βœ”οΈ βœ”οΈ ❌
Portal Support βœ”οΈ βœ”οΈ ❌
Game per-object collide callback support
eg. no-collide
βœ”οΈ βœ”οΈ ❌
Crash-resistant solver ❌ βœ”οΈ (no data)
Supports thousands of objects without lag ❌ βœ”οΈ ❌
Multithreaded ❌ βœ”οΈ βœ”οΈ (partially)
Proper player controller βœ”οΈ βœ”οΈ βœ”οΈ (partially)

Bugs

VPhysics Jolt is not without its flaws, however. See the issue tracker for bugs that are known.

There are definitely going to be bugs that we don't know about or haven't encountered, or different quirks across engine branches.

How to build

The Volt code is provided as-is, it is up to you to build it for your SDK, etc.

Volt should build fine against Source SDK 2013 and Alien Swarm SDK on a MSVC or GCC compiler with at least C++20 support.

If you are building directly against the public SDK 2013 and Alien Swarm SDKs, you will need to do minor work to memoverride.cpp to make it compatible with the newer compilers and newer Windows SDKs.

Unfortunately we cannot redistribute the additional code/headers needed to build Volt for games such as Garry's Mod which uses a different VPhysics interface (CS:GO's) to what is found in the Valve-provided public SDKs.

For full build instructions pertaining to SDK 2013, refernce build.md.

Download

Development builds for each commit for SDK2013 SP/MP + ASW are available as artifacts on each commit on GitHub through GitHub Actions.
Development builds for each commit for Garry's Mod are available on froggi.es.

For each release, binary builds are provided for Garry's Mod and Source SDK 2013 on the Releases page.

Media

Lots of Melons + Dumpster

Lots of Melons + Dumpster

Physically Simulated Chain

Physically Simulated Chain

Lots of Balls Test

Lots of Balls Test

Wheels + Weld Car Dupe Test

Weld Car Dupe Test

Door + NPC (Physics Shadowed Objects) Test

Door + NPC (Physics Shadowed Objects) Test

Lots of Cubes + Ragdolls + Funnel

Lots of Cubes + Ragdolls + Funnel

Slow Mo Cubes

Slow Mo Cubes

Propane in Dumpster

Propane in Dumpster

Have some cool media of stuff going on in Volt you'd like to add? Feel free to make a pull request!

Projects using Volt

Portal 2: Desolation

Prelude: Online

Have fun! 🐸⚑