ContextQMD
Back to Box2d

Build Status

README.md

3.1.13.3 KB
Original Source

Build Status

Box2D

Box2D is a 2D physics engine for games.

Features

Collision

  • Continuous collision detection
  • Contact events
  • Convex polygons, capsules, circles, rounded polygons, segments, and chains
  • 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

  • OpenGL with GLFW and enkiTS
  • Graphical user interface with imgui
  • Many samples to demonstrate features and performance

Building for Visual Studio

  • Install CMake
  • Ensure CMake is in the user PATH
  • Run create_sln.bat
  • Open and build build/box2d.sln

Building for Linux

  • Run build.sh from a bash shell
  • Results are in the build sub-folder

Building for Xcode

  • Install CMake
  • Add Cmake to the path in .zprofile (the default Terminal shell is zsh)
    • export PATH="/Applications/CMake.app/Contents/bin:$PATH"
  • mkdir build
  • cd build
  • cmake -G Xcode ..
  • Open box2d.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 Box2D library and samples build and run on Windows, Linux, and Mac.

You will need a compiler that supports C17 to build the Box2D library.

You will need a compiler that supports C++20 to build the samples.

Box2D uses SSE2 and Neon SIMD math to improve performance. This can be disabled by defining BOX2D_DISABLE_SIMD.

Documentation

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

Box2D is developed by Erin Catto and uses the MIT license.

Sponsorship

Support development of Box2D through Github Sponsors.

Please consider starring this repository and subscribing to my YouTube channel.

External ports, wrappers, and bindings (unsupported)