# use-cannon

**Repository Path**: mirrors-gis/use-cannon

## Basic Information

- **Project Name**: use-cannon
- **Description**: pmnd   
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-03-07
- **Last Updated**: 2024-03-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[![Build Status](https://img.shields.io/github/actions/workflow/status/pmndrs/use-cannon/nodejs.yml?branch=master&style=flat&colorA=000000&logo=github)](https://github.com/pmndrs/use-cannon/actions/workflows/nodejs.yml)
[![Discord Shield](https://img.shields.io/discord/740090768164651008?style=flat&colorA=000000&colorB=000000&label=discord&logo=discord&logoColor=ffffff)](https://discord.gg/poimandres)

![Imgur](https://imgur.com/FpBsJPL.jpg)

Monorepo for [cannon-es](https://github.com/pmndrs/cannon-es) web worker packages.

| Package                                                                  | Description                                                                                                                                                      |
| ------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`@react-three/cannon`](./packages/react-three-cannon)                   | React hooks for [cannon-es](https://github.com/pmndrs/cannon-es). Use this in combination with [react-three-fiber](https://github.com/pmndrs/react-three-fiber). |
| [`@pmndrs/cannon-worker-api`](./packages/cannon-worker-api)              | Web worker api for [cannon-es](https://github.com/pmndrs/cannon-es). Used by `@react-three/cannon`.                                                              |
| [`@react-three/cannon-examples`](./packages/react-three-cannon-examples) | Examples for `@react-three/cannon`                                                                                                                               |

## `use-cannon` Documentation

Please see the [`@react-three/cannon` README](./packages/react-three-cannon/README.md) documentation and getting started guide for using the react hooks and jsx interface.

## Demos

Check out all of our `@react-three/cannon` examples at https://cannon.pmnd.rs

The code for the examples lives in [./packages/react-three-cannon-examples](./packages/react-three-cannon-examples)