bevy_easy_portals 0.3.1

Bevy plugin for easy-to-use portals.
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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80

# `bevy_easy_portals`

Easy-to-use portals for Bevy

![screenshot showing a cube being reflected in a mirror using portals](https://raw.githubusercontent.com/chompaa/bevy_easy_portals/main/assets/mirror.png)

## Getting Started

First, add `PortalPlugin` to your app, then use the `Portal` component, et voila!

See [the examples](https://github.com/chompaa/bevy_easy_portals/tree/main/examples) for more references.

<details>

<summary>Example usage</summary>

```rust
use bevy::prelude::*;
use bevy_easy_portals::{Portal, PortalPlugin}

fn main() {
    App::new()
        .add_plugins((DefaultPlugins, PortalPlugin))
        .add_systems(Startup, setup)
        .run();
}

fn setup(
    mut commands: Commands,
    mut materials: ResMut<Assets<StandardMaterial>>,
    mut meshes: ResMut<Assets<Mesh>>,
) {
    let primary_camera = commands
        .spawn((Camera3d::default(), Transform::from_xyz(0.0, 0.0, 10.0)))
        .id();

    // Spawn something for the portal to look at
    commands.spawn((
        Mesh3d(meshes.add(Cuboid::default())),
        MeshMaterial3d(materials.add(Color::WHITE)),
        Transform::from_xyz(10.0, 0.0, 0.0),
    ));

    // Where the portal's target camera should be
    let target = commands.spawn(Transform::from_xyz(10.0, 0.0, 10.0)).id();
    // Where the portal should be located
    let portal_transform = Transform::default();
    // Spawn the portal, omit a material since one will be added automatically
    commands.spawn((
        Mesh3d(meshes.add(Rectangle::default())),
        portal_transform,
        Portal::new(primary_camera, target),
    ));
}
```

</details>

## Compatibility

| `bevy_easy_portals` | `bevy` |
| :--                 | :--    |
| `0.3`               | `0.15` |
| `0.1..0.2`          | `0.14` |

## Features

| Feature                | Description                                           |
| :--                    | :--                                                   |
| `gizmos`               | Use gizmos for the portal's aabb and camera transform |

## Contributing

Feel free to open a PR!

If possible, please try to keep it minimal and scoped.

## Alternatives

- [`bevy_basic_portals`](https://github.com/Selene-Amanita/bevy_basic_portals)