bevy_shatter 0.1.0

A bevy plugin to allow simulating shattered glass
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

# **bevy_shatter**

Procedural glass shattering plugin for the [Bevy game engine](https://bevyengine.org/)

**Note**: This plugin uses [avian3d](https://github.com/Jondolf/avian) for collider generation, but [rapier3d](https://rapier.rs/) integration should be trivial to add in the future

![Demo](videos/example.webp)

# Usage

**Plugin**
 
Add the ShatterPlugin to register the needed hooks and resources.

**Creating glass**

Add the Glass component to an entity. A helper is available in AutoGlass to add other needed components automatically, such as a mesh and a transform with the correct scale.

**Shattering glass**

Add the Shattered component to an entity that has Glass, and glass shards will automatically be created.

# Customizing behaviour

This plugin prioritizes user control instead of guessing what the user wants to do, at a cost of convenience for the simpler use cases. You are responsible, for example, for adding RigidBody::Dynamic to each shard of glass (if that's what you need), and you can customize the entities using hooks.

**Making the original glass entity hidden**

This plugin does not assume what you want to do with the original Glass entity. If you want it to be hidden when the glass shatters, this will have to be done manually by inserting Visibility::Hidden.

**Shards**

Are entities with the Shard component.

You can use this to, for example, make an OnAdd hook that automatically makes shards have a dynamic rigid body when added.

**Shard relationship**

Shards and their Glass are related using ShardOf and Shards. You can use this to delete all the shards belonging to a glass, make all the shards have the same material as their glass, etc.

# Examples

See the [`examples/`](https://github.com/IVSOP/bevy_shatter/tree/main/examples) folder.

# Compatibility

| `bevy_shatter` | `bevy` |
| :--            | :--    |
| `0.1.0`        | `0.16` |

# How it works

Currently, the glass is broken into cells using a voronoi diagram. These cells are then extruded to 3D, creating a shard.

Each cell's position is chosen by dividing the glass into a grid, to ensure they are all roughly the same size, and then picking random points within each cell of the grid.

# Contributing

This plugin is in very early development. PRs and forks are welcome. See TODO.md for a list of things that are missing