Skip to content

Latest commit

 

History

History
67 lines (43 loc) · 4 KB

README.md

File metadata and controls

67 lines (43 loc) · 4 KB

screenshot Jitter Physics 2

GitHub Actions Workflow Status Nuget Discord

Jitter Physics 2, the evolution of Jitter Physics, is an impulse-based dynamics engine with a semi-implicit Euler integrator. It is a fast, simple, and dependency-free engine written in C# with a clear and user-friendly API.

Run a small demo directly in the browser!

There is a tiny demo available for the Godot engine.

The official NuGet package can be found here.

See below for a fully-featured demo.


screenshot screenshot

screenshot screenshot

Getting Started

Jitter is cross-platform. The src directory contains four projects:

Project Description
Jitter2 The main library housing Jitter2's functionalities.
JitterDemo Features demo scenes rendered with OpenGL, tested on Linux and Windows.
JitterBenchmark The setup for conducting benchmarks using BenchmarkDotNet.
JitterTests Unit tests utilizing NUnit.

To run the demo scenes:

  • Install .NET 9.0
  • git clone https://github.com/notgiven688/jitterphysics2.git
  • cd ./jitterphysics2/src/JitterDemo && dotnet run -c Release

JitterDemo uses GLFW for accessing OpenGL and managing windows, and cimgui for GUI rendering. The project contains these native binaries in a precompiled form. On Linux you may have to install GLFW, e.g. on Ubuntu sudo apt-get install libglfw3-dev.

Features

  • Speculative contacts (avoiding the bullet-through-paper problem).
  • A variety of constraints and motors (AngularMotor, BallSocket, ConeLimit, DistanceLimit, FixedAngle, HingeAngle, LinearMotor, PointOnLine, PointOnPlane, TwistAngle) with support for softness.
  • A sophisticated deactivation scheme with minimal cost for inactive rigid bodies (scenes with 100k inactive bodies are easily achievable).
  • Edge collision filter for internal edges of triangle meshes.
  • Substepping for improved constraint and contact stability.
  • Generic convex-convex collision detection using EPA-aided MPR.
  • "One-shot" contact manifolds using auxiliary contacts for flat surface collisions.
  • Efficient compound shapes.
  • Easy integration of custom shapes. Integrated: Box, Capsule, Cone, Convex Hull, Point Cloud, Sphere, Triangle, Transformed.
  • Soft-body dynamics!

Documentation

Find the documentation here.

Credits

Grateful acknowledgment to Erin Catto, Dirk Gregorius, Erwin Coumans, Gino van den Bergen, Daniel Chappuis, Marijn Tamis, Danny Chapman, Gary Snethen, and Christer Ericson for sharing their knowledge through forum posts, talks, code, papers, and books.

Special thanks also to the contributors of the predecessor projects JigLibX and Jitter.

Contribute 👋

Contributions of all forms are welcome! Feel free to fork the project and create a pull request.