Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/loopystudios/bevy_vello
An integration to render with Vello in Bevy game engine.
https://github.com/loopystudios/bevy_vello
bevy bevy-engine velato vello
Last synced: 2 months ago
JSON representation
An integration to render with Vello in Bevy game engine.
- Host: GitHub
- URL: https://github.com/loopystudios/bevy_vello
- Owner: loopystudios
- License: apache-2.0
- Created: 2023-04-27T21:02:05.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-05T01:39:31.000Z (2 months ago)
- Last Synced: 2024-04-06T02:05:06.923Z (2 months ago)
- Topics: bevy, bevy-engine, velato, vello
- Language: Rust
- Homepage: https://loopystudios.github.io/bevy_vello/
- Size: 523 KB
- Stars: 57
- Watchers: 2
- Forks: 5
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE-APACHE
Lists
- awesome-bevy - Vello
README
# Bevy Vello
**A vector graphics rendering integration for [Bevy game engine](https://bevyengine.org) using [Vello](https://vello.dev).**
[](https://discord.gg/zrjnQzdjCB)
[](#license)
[](https://crates.io/crates/vello)
[](https://github.com/loopystudios/bevy_vello/actions)
[](https://deps.rs/repo/github/loopystudios/bevy_vello)
[](https://crates.io/crates/bevy_vello)
[](https://docs.rs/bevy_vello)
> [!WARNING]
> The support of SVG and Lottie is limited. If there is an SVG-related issue, please file the issue in [`vello_svg`](https://github.com/linebender/vello_svg). If there is a Lottie-related issue, please file the issue in [`velato`](https://github.com/linebender/velato). Please see the respective backends for for more information about limitations.
bevy_vello is a rendering integration for rendering vector graphics in the Bevy game engine. Currently it renders standard vello `Scene`s, as well as SVG and Lottie files.
Quickstart to run the demo:
```shell
cargo run -p demo
```
It uses several support backends for assets:
- [`vello_svg`](https://github.com/linebender/vello_svg) - Converting SVG files to a vello `Scene`
- [`velato`](https://github.com/linebender/velato) - Converting Lottie files to a vello `Scene`
Visual inconsistencies discovered should be reported to the respective backend.
## Bevy version support
**NOTE**: You must use a git rev for now, but we are planning a publish. See [issue #3](https://github.com/loopystudios/bevy_vello/issues/3).
|bevy|bevy_vello|
|---|---|
|0.13|0.1, main|
|< 0.13| unsupported |
## Features
- Spawn vector graphics rendering in screen-space or world-space coordinates.
- Runtime color swapping of Lottie files with a `Theme` component.
- Augment playback options with a `PlaybackOptions` component.
- Limited state machine support with a `LottiePlayer` component.
- Text
- NOTE: To avoid conflict with bevy's built-in font loader, rename fonts used by `bevy_vello` to end with `*.vtff`. This is a limitation of the bevy game engine, and can probably be an improvement in the future.
- Debug drawing for bounding boxes and origin
- Render immediate-mode vello `Scene`s
## Examples
### Cross platform (Bevy)
```shell
cargo run -p
```
### Web platform
Because Vello relies heavily on compute shaders, we rely on the emerging WebGPU standard to run on the web.
Until browser support becomes widespread, it will probably be necessary to use development browser versions (e.g. Chrome Canary) and explicitly enable WebGPU.
This uses [`cargo-run-wasm`](https://github.com/rukai/cargo-run-wasm) to build the example for web, and host a local server for it
```shell
# Make sure the Rust toolchain supports the wasm32 target
rustup target add wasm32-unknown-unknown
# The binary name must also be explicitly provided as it differs from the package name
cargo run_wasm -p text
```
There is also a web demo [available here](https://loopystudios.github.io/bevy_vello) on supporting web browsers.
> [!WARNING]
> The web is not currently a primary target for Vello, and WebGPU implementations are incomplete, so you might run into issues running this example.
## Community
All Loopy projects and development happens in the [Loopy Discord](https://discord.gg/zrjnQzdjCB). The discord is open to the public.
Contributions are welcome by pull request. The [Rust code of conduct](https://www.rust-lang.org/policies/code-of-conduct) applies.
## License
Licensed under either of
- Apache License, Version 2.0
([LICENSE-APACHE](LICENSE-APACHE) or )
- MIT license
([LICENSE-MIT](LICENSE-MIT) or )
at your option
The files in subdirectories of the [`examples/assets`](/examples/assets) directory are licensed solely under
their respective licenses, available in the `LICENSE` file in their directories.
## Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.