What is this?
Box3D is a 3D physics engine for games, written by Erin Catto, the author of Box2D.
Box3D is a 3D physics engine for games, written by Erin Catto, the author of Box2D.Is it a library I link into my game, or a program I run?A C library you link into your game - the CMake target is box3d::box3d. The repo also ships a samples app with an imgui UI for trying features.
A C library you link into your game - the CMake target is box3d::box3d. The repo also ships a samples app with an imgui UI for trying features.How do I add it to my own project?Easiest is CMake FetchContent; a vendored copy or git submodule goes through add_subdirectory, and an installed copy via find_package. docs/hello.md walks you through a minimal first program.
Easiest is CMake FetchContent; a vendored copy or git submodule goes through add_subdirectory, and an installed copy via find_package. docs/hello.md walks you through a minimal first program.What do I need to build it?CMake, git and a C17-capable compiler. The library itself needs nothing beyond the C runtime (libm on Unix); the samples additionally require C++20.
CMake, git and a C17-capable compiler. The library itself needs nothing beyond the C runtime (libm on Unix); the samples additionally require C++20.Any build pitfalls I should know about?It uses SSE2 and Neon SIMD by default, and even the WebAssembly build relies on SSE2 - on older hardware define BOX3DDISABLESIMD to build without it.
It uses SSE2 and Neon SIMD by default, and even the WebAssembly build relies on SSE2 - on older hardware define BOX3DDISABLESIMD to build without it.Which platforms does it run on?Windows, Linux and macOS, with CMake presets for each (plus MinGW and Xcode). There is also an Emscripten build targeting WebAssembly.
Windows, Linux and macOS, with CMake presets for each (plus MinGW and Xcode). There is also an Emscripten build targeting WebAssembly.Can I use it in a commercial game?Yes - Box3D is MIT licensed, so commercial use is fine. It is developed by Erin Catto and supported through GitHub Sponsors.
Yes - Box3D is MIT licensed, so commercial use is fine. It is developed by Erin Catto and supported through GitHub Sponsors.What physics features does it include?Collision: continuous detection, convex hulls, capsules, spheres, triangle meshes and height fields, sensors, a character mover, plus ray casts, shape casts and overlap queries. Physics: a Soft Step rigid body solver, island-based sleep, and revolute, prismatic, distance, motor, weld and wheel joints with limits, motors and springs.
Collision: continuous detection, convex hulls, capsules, spheres, triangle meshes and height fields, sensors, a character mover, plus ray casts, shape casts and overlap queries. Physics: a Soft Step rigid body solver, island-based sleep, and revolute, prismatic, distance, motor, weld and wheel joints with limits, motors and springs.How do I try it before wiring it into my game?Build the samples with the CMake presets - for example cmake --preset windows, then cmake --build --preset windows-release - and run the samples executable from the Box3D directory. The app has an imgui interface and demos for most features.
Build the samples with the CMake presets - for example cmake --preset windows, then cmake --build --preset windows-release - and run the samples executable from the Box3D directory. The app has an imgui interface and demos for most features.Is this the 3D successor to Box2D?Effectively yes. It comes from Erin Catto, the author of Box2D, and the README mentions tooling for migrating code between Box2D and Box3D.
Effectively yes. It comes from Erin Catto, the author of Box2D, and the README mentions tooling for migrating code between Box2D and Box3D.Did the author use AI to write it?Partly. LLMs were used for unit tests, the samples app, Box2D/Box3D code migration, build configuration, code reviews and benchmarking; the rest of the code is written by the author, who says he takes responsibility for every line.
Partly. LLMs were used for unit tests, the samples app, Box2D/Box3D code migration, build configuration, code reviews and benchmarking; the rest of the code is written by the author, who says he takes responsibility for every line.What are similar projects?box2d, bgfx, JoltPhysics, raylib, iw4L, bevy, flutter_scene, GDevelop
box2d, bgfx, JoltPhysics, raylib, iw4L, bevy, flutter_scene, GDevelopWhich topics is it in?physics, multithreading, game-engine, simulation, game-development, game, wasm, 3d, c, cpp, developers, performance
physics, multithreading, game-engine, simulation, game-development, game, wasm, 3d, c, cpp, developers, performance