bevy_collider_gen

KO | EN

gitlite — search

#python #react #llm #android #rust #linux #docker #windows #awesome #kubernetes #awesome-list #vue #security #openai

bevy_collider_gen

(★ 104)

a library for generating 2D colliders for bevy apps from images

bevy_collider_gen Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# `bevy_collider_gen`

[![Crates.io](https://img.shields.io/crates/v/bevy_collider_gen.svg)](https://crates.io/crates/bevy_collider_gen)
[![Crates.io](https://img.shields.io/crates/d/bevy_collider_gen.svg)](https://crates.io/crates/bevy_collider_gen)
[![Bevy](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2Fshnewto%2Fbevy_collider_gen%2Fmain%2FCargo.toml&query=%24.dependencies.bevy.version&label=bevy&color=pink)](https://crates.io/crates/bevy)
[![MIT/Apache 2.0](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](https://github.com/shnewto/bevy_collider_gen#license)

A library for generating 2d colliders, for bevy apps, from images with transparency

## Specifying your dependency

By default, `bevy_rapier2d` is enabled (along with `parallel` and `plugin`).
This is to help with the out of box experience, specifically,
being able to run examples and tinker.

But you'll probably only want to just use one of the physics engines supported
so when you use it in your own crate fill in in the `bevy_collider_gen`
dependencies with something like this for `bevy_rapier2d`

```toml
[dependencies.bevy_collider_gen]
# replace "*" with the most recent version of bevy_collider_gen
version = "*"
```

Or this for `avian2d`

```toml
[dependencies.bevy_collider_gen]
# replace "*" with the most recent version of bevy_collider_gen
version = "*"
features = ["avian2d", "parallel"]
default-features = false
```

## Example

![example with a car, terrain, and boulders](https://github.com/shnewto/bevy_collider_gen/blob/main/img/example-default.png?raw=true)

To see this in action you can run the example, with no arguments
it generates a scene with various colliders using PNG's in the `assets/sprite` directory

### `bevy_rapier2d`

```sh
cargo run --example rapier2d_colliders
```

### avian2d

```sh
cargo run --example avian2d_colliders -F avian2d
```

### Texture atlas

Shows a `DynamicCollider` regenerating when the `TextureAtlas` frame changes.
Defaults to `rapier2d`; pass `-F avian2d` to use avian instead

```sh
cargo run --example texture_atlas
cargo run --example texture_atlas -F avian2d
```

You can also specify a path to an image yourself the example will attempt to
generate one or more `convex_polyline` colliders for the objects it finds

## About / why

I was looking for a way to iterate on some 2d scenes with colliders
on things with more sophisticated shapes than simple
geometry, I figured there should be enough info in an image with
transparency to generate colliders, and... there is! So i
packaged up my approach here in case anyone else could benefit.

## How it works

😄 head on over to the edges crate to learn more <https://github.com/shnewto/edges>

## Caveats

- as mentioned here and there in these docs, this implementation requires
  images to have transparency in order to distinguish object from non-object :)
- i imagine for generating things at a larger scale, i.e. colliders
  for sets of sprites bigger than pixel counts in the hundreds, this implementation
  won't be performant to do at runtime. I'll suggest serializing the colliders
  you like and deserializing in your app instead of doing all the number crunching
  on load when you need a performance boost

## Examples of colliders generated for assets/sprite/car.png

(as in pictures of the sort of thing you can expect,
not the runnable bevy app example. That's a couple headings up)

### convex polyline (`bevy_raiper2d` only)

![convex polyline collider on an upside down car sprite](https://github.com/shnewto/bevy_collider_gen/blob/main/img/convex-polyline.png?raw=true)

### polyline

![polyline collider on an upside down car sprite](https://github.com/shnewto/bevy_collider_gen/blob/main/img/polyline.png?raw=true)

### convex hull

![convex hull collider on an upside down car sprite](https://github.com/shnewto/bevy_collider_gen/blob/main/img/convex-hull.png?raw=true)

### heightfield

The current implementation does best if the image
you're generating a heightfield from is either centered in the image
or spans the entire width of the image...

![heightfield collider on an upside down car sprite](https://github.com/shnewto/bevy_collider_gen/blob/main/img/heightfield.png?raw=true)

### convex decomposition

I didn't add support for convex decomposition directly because when
sprites were small, and collisions were forceful, they were sort of unreliable
(occasional panics because of bounds indexing in rapier's dependencies 💀).
But if you wanted to use convex decomposition colliders you could construct
them with the edge coordinates from your image with something like this

```rust,ignore
let sprite_image = image_assets.get(sprite_handle.unwrap()).unwrap();
let edges = Edges::try_from(sprite_image).unwrap();
let edge_coordinate_groups = edges.multi_translated();
for coords in edge_coordinate_groups {
    let indices: Vec<[u32; 2]> = (0..coords.len()).map(|i| [i as u32, (i as u32 + 1) % coords.len() as u32]).collect();
    let collider = Collider::convex_decomposition(&coords, &indices);
    commands.spawn((
        collider,
        RigidBody::Fixed,
        Sprite::from_image(sprite_handle.clone()),
    ));
}
```

![convex decomposition collider on a car sprite](https://github.com/shnewto/bevy_collider_gen/blob/main/img/convex-decomposition.png?raw=true)

## License

All code in this repository is dual-licensed under either:

- MIT License (LICENSE-MIT or <http://opensource.org/licenses/MIT>)
- Apache License, Version 2.0 (LICENSE-APACHE or <http://www.apache.org/licenses/LICENSE-2.0>)

At your option.

bevy_collider_gen

bevy_collider_gen Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

bevy_collider_gen

bevy_collider_gen Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README