https://github.com/neu5/cannon-es-debugger-babylonjs

This is a debugger for use with cannon-es and BabylonJS
https://github.com/neu5/cannon-es-debugger-babylonjs

babylonjs cannon-es cannonjs debugger physics

Last synced: about 2 months ago
JSON representation

This is a debugger for use with cannon-es and BabylonJS

• Host: GitHub
• URL: https://github.com/neu5/cannon-es-debugger-babylonjs
• Owner: neu5
• License: mit
• Created: 2022-09-18T14:14:21.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-01-22T05:29:18.000Z (11 months ago)
• Last Synced: 2024-10-03T15:19:05.700Z (3 months ago)
• Topics: babylonjs, cannon-es, cannonjs, debugger, physics
• Language: HTML
• Homepage: https://neu5.github.io/cannon-es-debugger-babylonjs/
• Size: 2.14 MB
• Stars: 8
• Watchers: 2
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-babylonjs - cannon-es-debugger-babylonjs - This is a debugger for use with cannon-es. ([demo](https://neu5.github.io/cannon-es-debugger-babylonjs/)) (Projects)

README

        
[![Deploy demo on GH Pages](https://github.com/neu5/cannon-es-debugger-babylonjs/actions/workflows/deploy-demo.yml/badge.svg)](https://github.com/neu5/cannon-es-debugger-babylonjs/actions/workflows/deploy-demo.yml)

# cannon-es-debugger-babylonjs

This is a debugger for use with [cannon-es](https://github.com/pmndrs/cannon-es) and [BabylonJS](https://www.babylonjs.com/).

## Example

https://neu5.github.io/cannon-es-debugger-babylonjs/

## Installation

```

yarn add cannon-es-debugger-babylonjs --dev

```

Make sure you also have `@babylonjs/core` and `cannon-es` installed.

## Usage

To make it work in your BabylonJS + cannon-es project you need these three steps:

1. import the `CannonDebugger` from the installed package

```javascript

import CannonDebugger from "cannon-es-debugger-babylonjs";

```

2. initialise the cannonDebugger passing the `scene` and the `physicalWorld`

```javascript

const cannonDebugger = new CannonDebugger(scene, physicalWorld);

```

3. update the cannonDebugger inside of your render loop

```javascript

engine.runRenderLoop(function () {

  // make the next step with the physicalWorld

  physicalWorld.fixedStep();

  // update debugger

  cannonDebugger.update();

  // possibly you want to update your meshses positions

  updateMeshPositions();

  // render the scene

  scene.render();

});

```

## Credits

This is a debugger inspired by https://github.com/pmndrs/cannon-es-debugger which was adapted from the original cannon.js debugger written by Stefan Hedman [@schteppe](https://github.com/schteppe).

### Development

First install all the dependencies by running

```

yarn

```

or `npm install`

Next create developer's build with watcher by running

```

yarn dev

```

and in another terminal window start serving the application with

```

yarn start

```

This will show you the `index.html` at the `localhost:3000`