- C 95.1%
- C++ 4.2%
- CMake 0.6%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
Recording and replay system for Box3D. Ported from Box2D. b3HeightField is now b3HeightFieldData and is a blob. |
||
| .github | ||
| benchmark | ||
| data | ||
| docs | ||
| extern/sokol | ||
| include/box3d | ||
| samples | ||
| shared | ||
| src | ||
| test | ||
| .clang-format | ||
| .gitattributes | ||
| .gitignore | ||
| build.sh | ||
| build_vs2026.bat | ||
| CMakeLists.txt | ||
| deploy_docs.sh | ||
| LICENSE | ||
| README.md | ||
Box3D
Box3D is a 3D physics engine for games.
Build Status
Features
Collision
- Continuous collision detection
- Contact events
- Convex hulls, capsules, spheres, triangle meshes, and height fields
- Multiple shapes per body
- Collision filtering
- Ray casts, shape casts, and overlap queries
- Sensor system
Physics
- Robust Soft Step rigid body solver
- Continuous physics for fast translations and rotations
- Island based sleep
- Revolute, prismatic, distance, mouse joint, weld, and wheel joints
- Joint limits, motors, springs, and friction
- Joint and contact forces
- Body movement events and sleep notification
System
- Data-oriented design
- Written in portable C17
- Extensive multithreading and SIMD
- Optimized for large piles of bodies
Samples
- Uses sokol to run with D3D11 on Window, Metal on macOS, and OpenGL 4.3 on Linux
- Graphical user interface with imgui
- Many samples to demonstrate features and performance
Building All Platforms
Building for Visual Studio
- Install Visual Studio
- Run
build_vs2026.bat - Open and build
build/box3d.slnx
Building for Linux
- Run
build.shfrom a bash shell - Results are in the build sub-folder
Building for Xcode
- mkdir build
- cd build
- cmake -G Xcode ..
- Open
box3d.xcodeproj - Select the samples scheme
- Build and run the samples
Building and installing
- mkdir build
- cd build
- cmake ..
- cmake --build . --config Release
- cmake --install . (might need sudo)
Compatibility
The Box3D library and samples build and run on Windows, Linux, and Mac.
You will need a compiler that supports C17 to build the Box3D library.
You will need a compiler that supports C++20 to build the samples.
Box3D uses SSE2 and Neon SIMD math to improve performance. This can be disabled by defining BOX3D_DISABLE_SIMD.
Documentation
The user manual lives in docs/ and is built with Doxygen. Enable the BOX3D_DOCS CMake option and build the doc target.
Community
Contributing
Please do not submit pull requests. Instead, please file an issue for bugs or feature requests. For support, please visit the Discord server.
Giving Feedback
Please file an issue or start a chat on discord. You can also use GitHub Discussions.
License
Box3D is developed by Erin Catto and uses the MIT license.
Sponsorship
Support development of Box3D through Github Sponsors.
Please consider starring this repository and subscribing to my YouTube channel.