Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
simbleau committed Jul 20, 2023
1 parent aff577f commit b5b0afa
Showing 1 changed file with 7 additions and 24 deletions.
31 changes: 7 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,26 @@
# Bevy Vello

![MIT/Apache 2.0](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)
[![crates.io](https://img.shields.io/crates/v/bevy-async-task.svg)](https://crates.io/crates/bevy-async-task)
[![docs.rs](https://img.shields.io/docsrs/bevy-async-task)](https://docs.rs/bevy-async-task)
[![crates.io](https://img.shields.io/crates/v/bevy_vello.svg)](https://crates.io/crates/bevy_vello)
[![docs.rs](https://img.shields.io/docsrs/bevy_vello)](https://docs.rs/bevy_vello)
[![Discord](https://img.shields.io/discord/913957940560531456.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/zrjnQzdjCB)

A bevy plugin which provides rendering support for Lottie animations and SVGs via [vello](https://github.com/linebender/vello.git).
A bevy plugin which provides rendering support for [lottie](https://lottiefiles.com/what-is-lottie) animations and SVGs on [Bevy](https://bevyengine.org/) using [Vello](https://github.com/linebender/vello.git) and [Velato](https://github.com/linebender/velato). Supports **wasm** and **native**. Untested on Android/iOS.

![Alt text](image.png)

Supports both **wasm/webgpu** and **native**.

Why vello?

- Fonts render with infinite resolution (no pixelation), even when dynamically scaling
- Render SVGs and [Lottie](https://lottiefiles.com/what-is-lottie) animations with infinite resolution, no tessellation necessary
- Performant graphics--rendering in compute shaders

## Features

- Spawnable vector graphics on separate layers
- Spawn vector graphics on separate layers
|Layer|Render order|
|---|---|
|Background|Always behind all other layers|
|Ground|2.5D-style render ordering via Y-coordinate|
|Foreground|Always on top of Ground/Background|
|UI|On top of Foreground layer; shows Bevy UI Nodes bundled with a `VelloVector` |
- Support for fonts
- NOTE: to avoid conflict with bevy's built-in font loader, rename fonts used by bevy_vello to something else (example: `*.vtff`). This can probably be an improvement in the future
- Option to debug draw gizmos for the objects local origin (red X) and canvas size (white box)
- NOTE: to avoid conflict with bevy's built-in font loader, rename fonts used by bevy_vello to something else (example: `*.vtff`). This can probably be an improvement in the future.
- Debug draw gizmos for the objects local origin (red X) and canvas size (white bounding box)

## Run Demo

Expand All @@ -53,16 +45,7 @@ Why vello?

## Attributions

### Libraries Used

`bevy_vello` is only possible because of these awesome libraries

- [vello](https://github.com/linebender/vello): Rendering backend for drawing vector curves, paths, shapes, effects, etc.
- [velato](https://github.com/linebender/velato): integration and parsing library for Lottie files (vector graphic animations).

### Assets Used

The animated vector graphic in `examples/demo` is sourced from Google Fonts [Noto Animated Emojis](https://googlefonts.github.io/noto-emoji-animation/documentation)
The animated vector graphic in the README and demo is a lottie file available from Google Fonts' [Noto Animated Emojis](https://googlefonts.github.io/noto-emoji-animation/documentation).
## License
Expand Down

0 comments on commit b5b0afa

Please sign in to comment.