{"id":17250089,"url":"https://github.com/stephengold/kk-physics","last_synced_at":"2025-04-14T05:11:00.956Z","repository":{"id":244555923,"uuid":"815580233","full_name":"stephengold/kk-physics","owner":"stephengold","description":"Integrate Jolt Physics into jMonkeyEngine projects (code has New BSD license) ","archived":false,"fork":false,"pushed_at":"2024-10-07T01:18:30.000Z","size":523,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-10-16T06:46:09.318Z","etag":null,"topics":["collision-detection","collision-shape","java","jolt-physics","open-source","physics","physics-3d","physics-engine","physics-simulation","rigid-bodies","rigid-body-dynamics"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stephengold.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-06-15T14:29:09.000Z","updated_at":"2024-10-07T01:18:34.000Z","dependencies_parsed_at":"2024-10-21T20:20:41.502Z","dependency_job_id":null,"html_url":"https://github.com/stephengold/kk-physics","commit_stats":null,"previous_names":["stephengold/kk-physics"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stephengold%2Fkk-physics","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stephengold%2Fkk-physics/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stephengold%2Fkk-physics/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stephengold%2Fkk-physics/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stephengold","download_url":"https://codeload.github.com/stephengold/kk-physics/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248824681,"owners_count":21167345,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["collision-detection","collision-shape","java","jolt-physics","open-source","physics","physics-3d","physics-engine","physics-simulation","rigid-bodies","rigid-body-dynamics"],"created_at":"2024-10-15T06:46:09.451Z","updated_at":"2025-04-14T05:11:00.950Z","avatar_url":"https://github.com/stephengold.png","language":"Java","funding_links":[],"categories":["Physics"],"sub_categories":[],"readme":"The [KK Physics Project][project] is about integrating\n[the Jolt Physics engine][jolt] into\n[the jMonkeyEngine (JME) game engine][jme].\n\nThis project is currently under development\nand is not intended for production use.\n\nIt contains 2 subprojects:\n\n 1. library: the KK Physics [JVM] runtime library and its automated tests\n 2. apps: non-automated test software\n\nComplete source code (in [Java]) is provided under\n[a 3-clause BSD license][license].\n\n\n\u003ca name=\"toc\"\u003e\u003c/a\u003e\n\n## Contents of this document\n\n+ [How to add KK Physics to an existing project](#add)\n+ [How to build KK Physics from source](#build)\n+ [External links](#links)\n+ [Acknowledgments](#acks)\n\n\n\u003ca name=\"add\"\u003e\u003c/a\u003e\n\n## How to add KK Physics to an existing project\n\nKK Physics comes pre-built as a single JVM library\nthat can be downloaded from Maven Central or GitHub.\n\nKK Physics replaces (and is thus incompatible with)\nthe jme3-bullet, jme3-jbullet, and Minie libaries.\nBefore adding KK Physics to a project,\nyou should remove those libraries\nso they won’t interfere with KK Physics.\n\nFor projects built using [Maven] or [Gradle], it is sufficient to add\ndependencies on the KK Physics library and appropriate Jolt-JNI native libraries.\nThe build tool should automatically resolve the remaining dependencies.\n\nCurrent Jolt-JNI releases provide 32 desktop native libraries,\neach specific to a particular platform, build type, and build flavor.\n\nEight desktop platforms are supported:\n+ \"Linux64\" (Linux on x86_64 CPUs)\n+ \"Linux64_fma\" (Linux on x86_64 CPUs with AVX2 and FMA extensions)\n+ \"Linux_ARM32hf\" (Linux on 32-bit ARM CPUs with hardware floating-point)\n+ \"Linux_ARM64\" (Linux on aarch64 CPUs)\n+ \"MacOSX64\" (macOS on Intel CPUs)\n+ \"MacOSX_ARM64\" (macOS on \"Apple Silicon\")\n+ \"Windows64\" (MS Windows on x86_64 CPUs)\n+ \"Windows64_avx2\" (MS Windows on x86_64 CPUs with AVX2 extensions)\n\nYour runtime classpath should include\nthe JVM library plus 1-to-8 native libraries:\na native library for each platform on which the code will run.\n\nBuild types:  use \"Debug\" native libraries for development and troubleshooting,\nthen switch to \"Release\" libraries for performance testing and production.\n\nBuild flavors:  use \"Dp\" to simulate large worlds (\u003e1000 meters in diameter)\notherwise use \"Sp\".\n\n### Gradle-built projects\n\nAdd to the project’s \"build.gradle\" or \"build.gradle.kts\" file:\n\n    repositories {\n        mavenCentral()\n    }\n    dependencies {\n        // JVM library:\n        implementation(\"com.github.stephengold:kk-physics:0.3.1\")\n\n        // native libraries:\n        runtimeOnly(\"com.github.stephengold:jolt-jni-Linux64:0.9.5:DebugSp\")\n        // Native libraries for other platforms could be added.\n    }\n\n+ The \"Linux64\" platform name may be replaced\n  with the name of another desktop platform.\n+ The \"DebugSp\" classifier\n  may be replaced by \"DebugDp\", \"ReleaseSp\", or \"ReleaseDp\".\n+ For some older versions of Gradle,\n  it's necessary to replace `implementation` with `compile`.\n\n### Maven-built projects\n\nAdd to the project’s \"pom.xml\" file:\n\n    \u003crepositories\u003e\n      \u003crepository\u003e\n        \u003cid\u003emvnrepository\u003c/id\u003e\n        \u003curl\u003ehttps://repo1.maven.org/maven2/\u003c/url\u003e\n      \u003c/repository\u003e\n    \u003c/repositories\u003e\n\n    \u003cdependency\u003e\n      \u003cgroupId\u003ecom.github.stephengold\u003c/groupId\u003e\n      \u003cartifactId\u003ekk-physics\u003c/artifactId\u003e\n      \u003cversion\u003e0.3.1\u003c/version\u003e\n    \u003c/dependency\u003e\n    \u003cdependency\u003e\n      \u003cgroupId\u003ecom.github.stephengold\u003c/groupId\u003e\n      \u003cartifactId\u003ejolt-jni-Linux64\u003c/artifactId\u003e\n      \u003cversion\u003e0.9.5\u003c/version\u003e\n      \u003cclassifier\u003eDebugSp\u003c/classifier\u003e\n    \u003c/dependency\u003e\n\n\n\u003ca name=\"build\"\u003e\u003c/a\u003e\n\n## How to build KK Physics from source\n\n### Initial build\n\n1. Install a [Java Development Kit (JDK)][adoptium],\n   if you don't already have one.\n2. Point the `JAVA_HOME` environment variable to your JDK installation:\n   (In other words, set it to the path of a directory/folder\n   containing a \"bin\" that contains a Java executable.\n   That path might look something like\n   \"C:\\Program Files\\Eclipse Adoptium\\jdk-17.0.3.7-hotspot\"\n   or \"/usr/lib/jvm/java-17-openjdk-amd64/\" or\n   \"/Library/Java/JavaVirtualMachines/zulu-17.jdk/Contents/Home\" .)\n  + using Bash or Zsh: `export JAVA_HOME=\"` *path to installation* `\"`\n  + using [Fish]: `set -g JAVA_HOME \"` *path to installation* `\"`\n  + using Windows Command Prompt: `set JAVA_HOME=\"` *path to installation* `\"`\n  + using PowerShell: `$env:JAVA_HOME = '` *path to installation* `'`\n3. Download and extract the KK Physics source code from GitHub:\n  + using [Git]:\n    + `git clone https://github.com/stephengold/kk-physics.git`\n    + `cd kk-physics`\n    + `git checkout -b latest 0.3.1`\n4. Run the [Gradle] wrapper:\n  + using Bash or Fish or PowerShell or Zsh: `./gradlew build`\n  + using Windows Command Prompt: `.\\gradlew build`\n\nAfter a successful build,\nMaven artifacts will be found in \"library/build/libs\".\n\n### Other tasks\n\nYou can install the artifacts to your local Maven repository:\n+ using Bash or Fish or PowerShell or Zsh: `./gradlew install`\n+ using Windows Command Prompt: `.\\gradlew install`\n\nYou can restore the project to a pristine state:\n+ using Bash or Fish or PowerShell or Zsh: `./gradlew clean`\n+ using Windows Command Prompt: `.\\gradlew clean`\n\n[Jump to the table of contents](#toc)\n\n\n\u003ca name=\"links\"\u003e\u003c/a\u003e\n\n## External links\n\n+ [Jolt Physics Multicore Scaling (2022)](https://jrouwe.nl/jolt/JoltPhysicsMulticoreScaling.pdf)\n+ [Architecting Jolt Physics (2022)](https://gdcvault.com/play/1027891/Architecting-Jolt-Physics-for-Horizon),\n  also in a different form [here](https://jrouwe.nl/architectingjolt/ArchitectingJoltPhysics_Rouwe_Jorrit_Notes.pdf)\n+ [Minie](https://stephengold.github.io/Minie/minie/overview.html),\n  a similar project that integrates Bullet Physics into jMonkeyEngine\n+ [The physics section of the jMonkeyEngine Wiki (2020)](https://wiki.jmonkeyengine.org/docs/3.4/physics/physics.html)\n+ [Alan Chou's game-physics tutorial (2013)](http://allenchou.net/game-physics-series/)\n\n[Jump to the table of contents](#toc)\n\n\n\u003ca name=\"history\"\u003e\u003c/a\u003e\n\n## History\n\nThe evolution of this project is chronicled in\n[its release log][log].\n\nThe API and much of the source code is derived from [Minie].\n\n[Jump to the table of contents](#toc)\n\n\n\u003ca name=\"acks\"\u003e\u003c/a\u003e\n\n## Acknowledgments\n\nLike most projects, the KK Physics Project builds on the work of many who\nhave gone before.  I therefore acknowledge the following\nsoftware developers:\n\n+ Jorrit Rouwe (aka \"jrouwe\") for creating the Jolt Physics Engine\n+ Normen Hansen (aka \"normen\") for creating most of the `jme3-bullet` library\n  (from which the KK Physics API is derived)\n+ \"aecsocket\" for creating the [JoltJava] bindings to the Jolt Physics Engine\n+ plus the creators of (and contributors to) the following software:\n    + the [Firefox] web browser\n    + the [Git] revision-control system and GitK commit viewer\n    + the [GitKraken] client\n    + the [Gradle] build tool\n    + the [Java] compiler, standard doclet, and runtime environment\n    + [jMonkeyEngine][jme] and the jME3 Software Development Kit\n    + the [Jolt Physics][jolt] Engine\n    + the [Linux Mint][mint] operating system\n    + [LWJGL], the Lightweight Java Game Library\n    + the [Markdown] document-conversion tool\n    + the [Meld] visual merge tool\n    + Microsoft Windows\n    + the [NetBeans] integrated development environment\n\nI am grateful to [GitHub] and [Sonatype]\nfor providing free hosting for this project\nand many other open-source projects.\n\nI'm also grateful to my dear Holly, for keeping me sane.\n\nIf I've misattributed anything or left anyone out, please let me know, so I can\ncorrect the situation: sgold@sonic.net\n\n[Jump to the table of contents](#toc)\n\n\n[adoptium]: https://adoptium.net/temurin/releases/ \"Adoptium Project\"\n[firefox]: https://www.mozilla.org/en-US/firefox \"Firefox\"\n[fish]: https://fishshell.com/ \"Fish command-line shell\"\n[git]: https://git-scm.com \"Git\"\n[github]: https://github.com \"GitHub\"\n[gitkraken]: https://www.gitkraken.com \"GitKraken client\"\n[gradle]: https://gradle.org \"Gradle Project\"\n[java]: https://en.wikipedia.org/wiki/Java_(programming_language) \"Java programming language\"\n[jme]: https://jmonkeyengine.org \"jMonkeyEngine Project\"\n[jolt]: https://jrouwe.github.io/JoltPhysics/index.html \"the Jolt Physics Engine\"\n[joltjava]: https://github.com/aecsocket/jolt-java?tab=readme-ov-file#readme \"JoltJava Project\"\n[jvm]: https://en.wikipedia.org/wiki/Java_virtual_machine \"Java virtual machine\"\n[license]: https://github.com/stephengold/kk-physics/blob/master/LICENSE \"KK Physics license\"\n[log]: https://github.com/stephengold/kk-physics/blob/master/library/release-log.md \"release log\"\n[lwjgl]: https://www.lwjgl.org \"Lightweight Java Game Library\"\n[markdown]: https://daringfireball.net/projects/markdown \"Markdown Project\"\n[maven]: https://maven.apache.org \"Maven Project\"\n[meld]: https://meldmerge.org \"Meld merge tool\"\n[minie]: https://stephengold.github.io/Minie/minie/overview.html \"Minie Project\"\n[mint]: https://linuxmint.com \"Linux Mint Project\"\n[netbeans]: https://netbeans.org \"NetBeans Project\"\n[project]: https://stephengold.github.io/kk-physics \"KK Physics Project\"\n[sonatype]: https://www.sonatype.com \"Sonatype\"\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstephengold%2Fkk-physics","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstephengold%2Fkk-physics","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstephengold%2Fkk-physics/lists"}