Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/not-elm/bevy_flurx_wry
The purpose of this crate is integrate bevy and wry using bevy_flurx.
https://github.com/not-elm/bevy_flurx_wry
bevy bevy-plugin game-development rust
Last synced: 3 months ago
JSON representation
The purpose of this crate is integrate bevy and wry using bevy_flurx.
- Host: GitHub
- URL: https://github.com/not-elm/bevy_flurx_wry
- Owner: not-elm
- License: apache-2.0
- Created: 2024-05-19T07:10:04.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-06-04T12:40:41.000Z (7 months ago)
- Last Synced: 2024-07-17T12:46:32.524Z (6 months ago)
- Topics: bevy, bevy-plugin, game-development, rust
- Language: Rust
- Homepage: https://docs.rs/crate/bevy_flurx_wry/latest
- Size: 3.35 MB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# bevy_flurx_wry
[](https://crates.io/crates/bevy_flurx_wry)
[](https://github.com/not-elm/bevy_flurx_wry#license)
[](https://crates.io/crates/bevy_flurx_wry)
> [!CAUTION]
> This crate is in the early stages of development and is subject to disruptive changes.
## Purpose
The purpose of this crate is integrate [bevy](https://github.com/bevyengine/bevy)
and [wry](https://github.com/tauri-apps/wry) using [bevy_flurx](https://github.com/not-elm/bevy_flurx).
In addition to that, I would like to take advantage of bevy's extensibility and discover bevy's potential to transcend
the framework of existing game engines.
## Platform Support
The operation has been confirmed on `Windows` and `MacOS`.
`Linux` is currently not supported.
## Usage
There are two ways to create a webview:
### Converts an existing window into a webview window.
[examples/simple.rs](examples/simple.rs)
```rust
use bevy::prelude::*;
use bevy::window::PrimaryWindow;
use bevy_flurx_wry::prelude::*;
fn spawn_webview(
mut commands: Commands,
window: Query>,
) {
// Converts the `Window` attached the entity into a webview window.
commands.entity(window.single()).insert(
WryWebViewBundle {
uri: WebviewUri::new("https://bevyengine.org/"),
..default()
}
);
}
```
### Create a webview as child inside a window.
[examples/child_view.rs](examples/child_view.rs)
```rust
use bevy::prelude::*;
use bevy::window::PrimaryWindow;
use bevy_flurx_wry::prelude::*;
fn spawn_webview(
mut commands: Commands,
window: Query>,
) {
commands.spawn((
WryWebViewBundle {
..default()
},
AsChildBundle {
// Here, create a webview as child inside a given window.
parent: ParentWindow(window.single()),
bounds: Bounds {
position: Vec2::new(100., 100.),
size: Vec2::new(500., 500.),
min_size: Vec2::new(100., 100.),
},
..default()
},
));
}
```
## Ipc
### IpcEvent
You can listen events from the webview and, conversely, emit events to the webview.
#### Webview(javascript) -> bevy
[examples/event_listen.rs](examples/event_listen.rs)
___javascript___
```javascript
// you can use any type.
const event = {
message: "message"
};
window.__FLURX__.emit("event_id", event);
```
___rust___
```rust
use bevy::prelude::*;
use bevy_flurx_wry::prelude::*;
use serde::Deserialize;
#[derive(Deserialize, Debug)]
struct MessageFromWebview {
message: String,
}
fn read_webview_message(
mut er: EventReader>
) {
for e in er.read() {
println!("webview message: {}", e.payload.message);
}
}
```
#### bevy -> Webview(javascript)
[examples/event_emit.rs](examples/event_emit.rs)
___javascript___
```javascript
window.__FLURX__.listen("event_id", ({message}) => {
console.log(message);
});
```
___rust___
```rust
use bevy::prelude::*;
use bevy_flurx_wry::prelude::*;
use serde_json::json;
fn emit_event(
mut views: Query<&mut EventEmitter>
) {
for mut emitter in views.iter_mut() {
emitter.emit("event_id", &serde_json::json!({
"message" : "hello world!"
}));
}
}
```
### IpcCommand
`IpcEvent` can't receive the output value from the other side.
In this case, `IpcCommand` can be used.
`IpcComamnd` can be divided into two command patterns: action-command, task-command
Please check [examples/ipc_command.rs](examples/ipc_command.rs) for details.
## Todo
- [ ] Enhance security
- [ ] Bug fix
- [ ] Add apis
- [ ] Support Linux(X11)
- [ ] Support Linux(Wayland)
## ChangeLog
Please see [here](https://github.com/not-elm/bevy_flurx_wry/blob/main/CHANGELOG.md).
## Compatible Bevy versions
| bevy_flurx_wry | bevy_flurx | bevy |
|----------------|------------|---------|
| 0.1.0-alpha1 | 0.5.2 | 0.13.2 |
## License
This crate is licensed under the MIT License or the Apache License 2.0.