Skip to content

Home

Jump to bottom
Ali Shakiba edited this page May 12, 2021 · 21 revisions

Home

Overview
API Conventions
Hello World
Body
Fixture
Shape
Joint
World
Contact
Collision
Testbed
Rendering
FAQ

Clone this wiki locally

Learning the basics

Planck.js user manual is ported from Box2D with updates for JavaScript. This user manual is the best place to start and learn the basics.

You can start from Overview section, or select other sections from the sidebar menu.

Run your code

Planck.js library is physics simulation and doesn't render anything itself. However, for learning, development and debugging you can use Testbed. Testbed runs physics simulation and visualizes your world. To learn more about Testbed API and usage see Testbed section.

For production you can create, or use an existing integration or renderer. See Rendering for more information about rendering and integration.

Explore examples

Planck.js examples are hosted on Space. Space is an online visual playground that runs Testbed scripts. You can explore and edit examples, or create and share new examples.

Explore the API

API Doc includes list of classes and methods with documentation. API Doc is helpful if you need to see what classes and methods are available and what they do, however to learn how to use the library you need to learn the basics first.

Online resources and advanced usage

After learning Planck.js basics and how to run your code, there are plenty of Box2D resources available online to learn advanced topics. Here are few great examples:

  • iforce2d - A collection of helpful Box2D tutorials
  • Box2D tutorials by Emanuele Feronato

Physics engine algorithms

If are interested in learning about algorithms used in Box2D/Planck.js following resources are helpful. However this is not needed for using the library.