Initial commit

Author: Yadhu-S

.clang-format

@@ -0,0 +1,50 @@
+StatementMacros: ['UPROPERTY', 'UFUNCTION', 'UCLASS', 'USTRUCT', 'UENUM', 'UINTERFACE', 'GENERATED_BODY']
+Language: Cpp
+BasedOnStyle: LLVM
+
+AccessModifierOffset: -4
+AlignAfterOpenBracket: DontAlign
+AlignConsecutiveDeclarations: true
+AlignEscapedNewlines: Left
+AlignOperands: DontAlign
+AlignTrailingComments: true
+AllowShortBlocksOnASingleLine: Empty
+AllowShortEnumsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: Inline
+AllowShortLambdasOnASingleLine: All
+BraceWrapping:
+  AfterCaseLabel: true
+  AfterClass: true
+  AfterControlStatement: true
+  AfterEnum: true
+  AfterFunction: true
+  AfterNamespace: true
+  AfterObjCDeclaration: true
+  AfterStruct: true
+  AfterUnion: true
+  AfterExternBlock: true
+  BeforeCatch: true
+  BeforeElse: true
+  BeforeLambdaBody: false
+  BeforeWhile: true
+  IndentBraces: false
+BreakBeforeBinaryOperators: NonAssignment
+BreakBeforeBraces: Custom
+BreakInheritanceList: AfterColon
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializers: BeforeComma
+BreakStringLiterals: false
+ColumnLimit: 0
+ConstructorInitializerAllOnOneLineOrOnePerLine: true
+Cpp11BracedListStyle: false
+EmptyLineBeforeAccessModifier: LogicalBlock
+IndentCaseBlocks: false
+IndentCaseLabels: true
+IndentPPDirectives: BeforeHash
+IndentWidth: 4
+NamespaceIndentation: All
+PointerAlignment: Left
+SortIncludes: false
+SpaceBeforeCaseColon: false
+TabWidth: 4
+UseTab: Always

.gitignore

@@ -0,0 +1,102 @@
+ Git files
+.git/
+
+# Visual Studio 2015 user specific files
+.vs/
+
+# Visual Studio 2015 database file
+*.VC.db
+
+# Compiled Object files
+*.slo
+*.lo
+*.o
+*.obj
+
+# Precompiled Headers
+*.gch
+*.pch
+
+# Compiled Dynamic libraries
+*.so
+*.dylib
+*.dll
+
+# Fortran module files
+*.mod
+
+# Compiled Static libraries
+*.lai
+*.la
+*.a
+*.lib
+
+# Executables
+*.exe
+*.out
+*.app
+*.ipa
+
+# These project files can be generated by the engine
+*.xcodeproj
+*.xcworkspace
+*.sln
+*.suo
+*.opensdf
+*.sdf
+*.VC.db
+*.VC.opendb
+
+# Precompiled Assets
+SourceArt/**/*.png
+SourceArt/**/*.tga
+
+# Binary Files
+Binaries/**
+Plugins/*/Binaries/*
+
+# Builds
+Build/*
+
+# Whitelist PakBlacklist-<BuildConfiguration>.txt files
+!Build/*/
+Build/*/**
+!Build/*/PakBlacklist*.txt
+
+# Don't ignore icon files in Build
+!Build/**/*.ico
+
+# Built data for maps
+*_BuiltData.uasset
+
+# Configuration files generated by the Editor
+Saved/*
+
+# Compiled source files for the engine to use
+Intermediate/**
+Plugins/*/Intermediate/*
+
+# Cache files for the editor to use
+DerivedDataCache/*
+
+# Mac crap
+.DS_Store
+
+# Un-Ignore All ThirdParty 
+!Source/ThirdParty/**
+
+# Ignore Export directory
+Export/**
+
+# Ignore VS Code files
+.vscode/**
+
+# Unignore .github folder
+!.github/**
+
+# Unignore .gitignore
+!.gitignore
+
+#ignore linux libs
+Source/ThirdParty/UnrealJoltLibrary/lib-*/**
+

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "Source/ThirdParty/UnrealJoltLibrary/JoltPhysics"]
+	path = Source/ThirdParty/UnrealJoltLibrary/JoltPhysics
+	url = git@github.com:jrouwe/JoltPhysics.git

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Yadhu-S
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,87 @@
+# UnrealJolt
+
+![Physics](Resources/Screenshots/play.gif)
+
+Plugin that brings [Jolt Physics](https://github.com/jrouwe/JoltPhysics) into unreal engine 5
+
+---
+
+## Getting Started
+
+### Some things to consider before using this
+
+- This is a bolt on integration and not a replacement for the existing chaos physics solver.
+- You should only need this if you specifically want some kind of behaviour that's not available in chaos.
+- Deterministic physics, multicore processing of many bodies could make the case.
+- Multicore processing it not yet implemented properly using Unreal's own thread pool system. 
+- The implementation of this plugin while is generic (somewhat), is still tied to something I am developing on the side. Just keep in mind that all features of UE might not be integrated, you might have to do it yourself. (Drop a PR if you do :) )
+- There are possibilities of breaking changes, until 1.0.0 at least. (will try to avoid)
+
+### Requirements
+
+- Unreal engine 5 (mostly tested on 5.6.0, should work on older versions)
+
+### Installation
+
+- Clone (`git clone --recursive git@github.com:Yadhu-S/UnrealJolt.git`) or download into the `Plugins` folder (`<project>/Plugins or Engine/Plugins`)
+- Take a look inside `UnrealJoltLibrary.Build.cs` to see the user defines, modify what you need, or leave defaults. Check the available defines [ here ]( https://jrouwe.github.io/JoltPhysicsDocs/5.3.0/md__build__r_e_a_d_m_e.html )
+- Compile project
+- Make sure UnrealJolt is enabled in "Plugins"
+- Use actor-tag and tag dynamic objects with `jolt-dynamic` (make sure that the object is movable) and static objects with `jolt-static` 
+
+### Configuration
+
+![Config](Resources/Screenshots/SS_Config.png)
+
+- Plugins->Jolt in your project settings.
+- Check the defaults, and change if required.
+- Debug rendering is slow, especially when visualizing large heightmaps. Drawing all those triangles. (Need to look into drawing triangles only once for
+  static objects )
+
+---
+
+## Features
+
+### UJoltSkeletalMeshComponent
+- UJoltSkeletalMeshComponent extends USkeletalMeshComponent to add jolt specific functionality (Browse JoltSkeletalMeshComponent.h to see the available functions)
+
+### Heightmaps 
+
+ ![Landscape](Resources/Screenshots/SS_Landscape.png)
+
+- **Landscapes** and **LandscapeSplines** are cooked automatically when you **Play in Editor**.  
+  - This may be a chore if you work with many levels, playing a level at least one time in editor (will work on it).  
+- **Heightmaps must be cooked** in advance. They are not added dynamically like other physics bodies.  
+- A `JoltData` directory is always generated during cooking and **must be included when packaging your project**.
+- #### ⚠️ Function for reading landscape spline data is not exposed by default in UE
+
+#### ✅ Enabling Landscape Spline Cooking
+1. `Engine/Source/Runtime/Landscape/Classes/LandscapeSplineSegment.h`  
+   and add `LANDSCAPE_API` to the `GetLocalMeshComponents()` declaration to fix link errors
+2. In `UnrealJolt/Source/UnrealJolt/UnrealJolt.Build.cs`, uncomment: 
+	`PublicDefinitions.Add("JOLT_PLUGIN_LANDSCAPE_API_MODIFIED");`
+---
+## Deterministic simulation
+
+To ensure deterministic simulation with Jolt Physics across platforms, follow the [official guidelines](https://jrouwe.github.io/JoltPhysicsDocs/5.3.0/index.html#deterministic-simulation). Use Jolt’s math and utility functions (`Sin`, `Cos`, `QuickSort`, `BinaryHeapPush/Pop`, `Hash`) instead of STL or platform-dependent ones, and always keep API calls (body/constraint creation, updates) in the same order.
+
+For builds:
+
+- On **Windows (MSVC)**, add `FPSemantics = FPSemanticsMode.Precise;` to `<ProjectName>Target.cs` and `<ProjectName>Editor.Target.cs`.  
+- On **Linux (Clang/GCC)**, add `AdditionalCompilerArguments += " -ffp-model=precise -ffp-contract=off";` to the same files.  
+
+Because these options differ from Unreal defaults (`LinuxToolChain.cs`, `VCToolChain.cs`), create a custom build config or apply the changes consistently across both game and editor builds by modifying:  
+`UnrealClient.Target.cs`, `UnrealEditor.Target.cs`, `UnrealGame.Target.cs`, and `UnrealServer.Target.cs`.
+
+---
+
+## Contributing
+
+ Found this project useful? Awesome!
+
+ If you’ve added a feature, fixed a bug, or improved something that isn’t here yet—feel free to open a PR!
+
+---
+## Credits
+- [Jorrit Rouwe](https://github.com/jrouwe) for making jolt
+- Andrea Catania for the video series on YouTube